跳转至

ParsedSourceDoc

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

继承链: System.Object → ParsedSourceDoc

声明

public sealed class ParsedSourceDoc

单个源文件(或合并后的类型级视图)的结构化 XML 文档注释解析结果。 键为全限定键(无程序集前缀,合并时按需添加): 类型级 Namespace.TypeName;成员级 Namespace.TypeName.MemberName, 方法与构造函数附参数后缀——参数类型键 Member(int, string)、参数计数键 Member(2), 参数列表提取失败时退化为无后缀键。构造函数额外发射 #ctor 键。

构造方法

名称 描述
ParsedSourceDoc() —

ParsedSourceDoc()

public ParsedSourceDoc()

属性

名称 描述
ParamSummaries 参数级文档字典( 标签),成员键 → 参数名 → 文本。
TypeParamSummaries 泛型参数文档字典( 标签),成员键 → 参数名 → 文本。
RemarksSummaries —
ReturnsSummaries —
Summaries —
ValueSummaries —
DeclaredNamespaces —
DeclaredTypeNames —

ParamSummaries

参数级文档字典( 标签),成员键 → 参数名 → 文本。

public Dictionary<string, Dictionary<string, string>> ParamSummaries { get; }

TypeParamSummaries

泛型参数文档字典( 标签),成员键 → 参数名 → 文本。

public Dictionary<string, Dictionary<string, string>> TypeParamSummaries { get; }

RemarksSummaries

public Dictionary<string, string> RemarksSummaries { get; }

ReturnsSummaries

public Dictionary<string, string> ReturnsSummaries { get; }

Summaries

public Dictionary<string, string> Summaries { get; }

ValueSummaries

public Dictionary<string, string> ValueSummaries { get; }

DeclaredNamespaces

public HashSet<string> DeclaredNamespaces { get; }

DeclaredTypeNames

public HashSet<string> DeclaredTypeNames { get; }

方法

声明的方法

名称 描述
MergeWithPrefix(ParsedSourceDoc, string) 将另一份解析结果按程序集键前缀合并进来(后写入覆盖同键,与历史行为一致)。

继承的方法

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

MergeWithPrefix(ParsedSourceDoc, string)

将另一份解析结果按程序集键前缀合并进来(后写入覆盖同键,与历史行为一致)。

public void MergeWithPrefix(ParsedSourceDoc other, string prefix)

参数

名称 类型 说明
other ParsedSourceDoc —
prefix string —

Additional Notes

首个 ## Additional Notes 是增量生成文档标识符,请勿修改标题级别和内容!本文档由 Script Doc Generator 辅助生成。