跳转至

DocGeneratorSettingsSO

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

继承链: System.Object → UnityEngine.Object → UnityEngine.ScriptableObject → DocGeneratorSettingsSO

声明

public abstract class DocGeneratorSettingsSO : UnityEngine.ScriptableObject

文档生成器设置抽象类

字段

名称 描述
customizeDocFileExtensionName 是否自定义文档扩展名
generateIdentifier 是否生成增量标识符
generateNamespaceFolder 是否按命名空间生成文件夹
docFileExtensionName 设置的文档扩展名

customizeDocFileExtensionName

是否自定义文档扩展名

[LabelText]
public bool customizeDocFileExtensionName;

generateIdentifier

是否生成增量标识符

[LabelText]
public bool generateIdentifier;

generateNamespaceFolder

是否按命名空间生成文件夹

[LabelText]
public bool generateNamespaceFolder;

docFileExtensionName

设置的文档扩展名

[EnableIf]
[LabelText]
public string docFileExtensionName;

属性

名称 描述 声明类型
hideFlags — Object
name — Object

方法

声明的方法

名称 描述
GetGeneratedDocumentation(ITypeData) 通过 TypeData 实例对象，生成文档内容。注意：不要在此方法中添加增量生成标识符
ResetToDefault() 重置文档生成器设置

继承的方法

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

GetGeneratedDocumentation(ITypeData)

通过 TypeData 实例对象，生成文档内容。注意：不要在此方法中添加增量生成标识符

public abstract string GetGeneratedDocumentation(ITypeData data)

参数

名称 类型 说明
data ITypeData —

返回值

类型 说明
string —

ResetToDefault()

重置文档生成器设置

[Button]
public void ResetToDefault()

Additional Notes

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