`XmlSummaryTool`¶

种类: class
命名空间: Runestone.AesirModules.ScriptDocGenerator.Editor
程序集: Runestone.AesirModules.Editor.OdinInspector

继承链: System.Object → XmlSummaryTool

声明¶

[Serializable]
public class XmlSummaryTool

C# 脚本的 XML 中的 Summary 注释的处理器。内容对齐方向（Sync/Replace）：[Summary] 特性优先——已有可解析特性时以特性文本为准（必要时回写 XML），无特性时回退 XML summary 生成特性。仅 Remove 模式不做内容对齐。

构造方法¶

名称	描述
`XmlSummaryTool(string)`	—

XmlSummaryTool(string)¶

public XmlSummaryTool(string sourceScript)

参数

名称	类型	说明
`sourceScript`	`string`	—

字段¶

名称	描述
`xmlCodeParts`	—
`headerLines`	第一个 XML 文档注释之前的所有代码行。
`sourceScriptLines`	源代码按行分割后的列表。
`firstXmlCommentLineIndex`	第一个 XML 文档注释的行号索引，从这一行开始处理 XML 文档注释。
`sourceScriptText`	原始源代码内容。

xmlCodeParts¶

public List<XmlCodePart> xmlCodeParts;

headerLines¶

第一个 XML 文档注释之前的所有代码行。

public List<string> headerLines;

sourceScriptLines¶

源代码按行分割后的列表。

public List<string> sourceScriptLines;

firstXmlCommentLineIndex¶

第一个 XML 文档注释的行号索引，从这一行开始处理 XML 文档注释。

public int firstXmlCommentLineIndex;

sourceScriptText¶

原始源代码内容。

public string sourceScriptText;

属性¶

名称	描述
`HeaderScript`	—

HeaderScript¶

public string HeaderScript { get; }

方法¶

声明的方法

名称	描述
`ParseSourceScript()`	解析源脚本，将其分解为头部部分和 XML 文档注释与代码块的组合列表。
`GetProcessedSourceScript(XmlSummaryTool.ProcessMode)`	获取处理后的完整脚本内容。Remove 模式下若无 [Summary] 特性则原样返回（不重写格式）。

继承的方法

名称	描述	声明类型
`GetType()`	—	`object`
`Equals(object)`	—	`object`
`GetHashCode()`	—	`object`
`ToString()`	—	`object`
`MemberwiseClone()`	—	`object`
`Finalize()`	—	`object`

ParseSourceScript()¶

解析源脚本，将其分解为头部部分和 XML 文档注释与代码块的组合列表。

public XmlSummaryTool ParseSourceScript()

返回值

类型	说明
`XmlSummaryTool`	—

GetProcessedSourceScript(XmlSummaryTool.ProcessMode)¶

获取处理后的完整脚本内容。Remove 模式下若无 [Summary] 特性则原样返回（不重写格式）。

public string GetProcessedSourceScript(XmlSummaryTool.ProcessMode processMode)

参数

名称	类型	说明
`processMode`	`XmlSummaryTool.ProcessMode`	—