跳转至

ScriptDocGeneratorUtility

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

继承链: System.Object → ScriptDocGeneratorUtility

声明

public static class ScriptDocGeneratorUtility

脚本文档生成器逻辑控制类，负责处理文档生成的核心逻辑

方法

声明的方法

名称 描述
AnalyzeSingleType(Type) —
AnalyzeMultipleAssemblies(List<string>) 分析多个程序集中的所有类型
AnalyzeMultipleTypes(List<Type>) —
AnalyzeMultipleTypes(TypesCacheSO) —
AnalyzeSingleAssembly(string) —
EnsureInitialized() 检查 Script Doc Generator 是否已初始化。未初始化时提示用户。
GenerateMultipleTypeDocs(List<ITypeData>, DocGeneratorSettingsSO, string) —
GenerateSingleTypeDoc(ITypeData, DocGeneratorSettingsSO, string) —
InitializeAssets() —

继承的方法

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

AnalyzeSingleType(Type)

public static ITypeData AnalyzeSingleType(Type targetType)

参数

名称 类型 说明
targetType Type —

返回值

类型 说明
ITypeData —

AnalyzeMultipleAssemblies(List)

分析多个程序集中的所有类型

public static List<ITypeData> AnalyzeMultipleAssemblies(List<string> assemblyFullNames)

参数

名称 类型 说明
assemblyFullNames List<string> —

返回值

类型 说明
List<ITypeData> —

AnalyzeMultipleTypes(List)

public static List<ITypeData> AnalyzeMultipleTypes(List<Type> types)

参数

名称 类型 说明
types List<Type> —

返回值

类型 说明
List<ITypeData> —

AnalyzeMultipleTypes(TypesCacheSO)

public static List<ITypeData> AnalyzeMultipleTypes(TypesCacheSO typesCache)

参数

名称 类型 说明
typesCache TypesCacheSO —

返回值

类型 说明
List<ITypeData> —

AnalyzeSingleAssembly(string)

public static List<ITypeData> AnalyzeSingleAssembly(string assemblyFullName)

参数

名称 类型 说明
assemblyFullName string —

返回值

类型 说明
List<ITypeData> —

EnsureInitialized()

检查 Script Doc Generator 是否已初始化。未初始化时提示用户。

public static bool EnsureInitialized()

返回值

类型 说明
bool true 表示已初始化（或用户刚确认初始化）；false 表示用户取消了初始化。

GenerateMultipleTypeDocs(List, DocGeneratorSettingsSO, string)

public static void GenerateMultipleTypeDocs(List<ITypeData> typeDataCollection, DocGeneratorSettingsSO generatorSettings, string targetFolderPath)

参数

名称 类型 说明
typeDataCollection List<ITypeData> —
generatorSettings DocGeneratorSettingsSO —
targetFolderPath string —

GenerateSingleTypeDoc(ITypeData, DocGeneratorSettingsSO, string)

public static void GenerateSingleTypeDoc(ITypeData typeData, DocGeneratorSettingsSO generatorSettings, string targetFolderPath)

参数

名称 类型 说明
typeData ITypeData —
generatorSettings DocGeneratorSettingsSO —
targetFolderPath string —

InitializeAssets()

public static void InitializeAssets()

Additional Notes

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