`ScriptDocGeneratorPanelSO`¶

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

继承链: System.Object → UnityEngine.Object → UnityEngine.ScriptableObject → Sirenix.OdinInspector.SerializedScriptableObject → ScriptDocGeneratorPanelSO

实现接口: UnityEngine.ISerializationCallbackReceiver

声明¶

public class ScriptDocGeneratorPanelSO : Sirenix.OdinInspector.SerializedScriptableObject, 
UnityEngine.ISerializationCallbackReceiver

ScriptDocGenerator 可视化操作面板类

构造方法¶

名称	描述
`ScriptDocGeneratorPanelSO()`	—

ScriptDocGeneratorPanelSO()¶

public ScriptDocGeneratorPanelSO()

属性¶

声明的属性

名称	描述
`TemporaryTypes`	—
`TypeSourceProperty`	—
`TargetType`	—
`Instance`	面板单例访问。解析结果按域缓存：缺失资产的解析会执行 CreateAsset 与 AssetDatabase.Refresh，每次都重新解析会把这类重操作带进绘制回调等高频路径。
`DefaultDocFolderPath`	—

继承的属性

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

TemporaryTypes¶

public List<Type> TemporaryTypes { get; set; }

TypeSourceProperty¶

public ScriptDocGeneratorPanelSO.TypeSource TypeSourceProperty { get; set; }

TargetType¶

public Type TargetType { get; set; }

Instance¶

面板单例访问。解析结果按域缓存：缺失资产的解析会执行 CreateAsset 与 AssetDatabase.Refresh，每次都重新解析会把这类重操作带进绘制回调等高频路径。

public static ScriptDocGeneratorPanelSO Instance { get; }

DefaultDocFolderPath¶

public static string DefaultDocFolderPath { get; } = "/Users/yuumix/Projects/Unity/AesirFramework/ScriptDocGenerator";

事件¶

名称	描述
`ToastRequested`	—

ToastRequested¶

public static event Action<ToastPosition, SdfIconType, string, Color, float> ToastRequested;

方法¶

声明的方法

名称	描述
`AnalyzeType()`	—
`GenerateDoc()`	—
`ResetToDefault()`	—

继承的方法

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

AnalyzeType()¶

[PropertyOrder]
[Title]
[Button]
public void AnalyzeType()

GenerateDoc()¶

[PropertyOrder]
[ShowIf]
[Title]
[Button]
public void GenerateDoc()

ResetToDefault()¶

[PropertyOrder]
[Title]
[InfoBox]
[Button]
public void ResetToDefault()

Additional Notes¶

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

ScriptDocGeneratorPanelSO¶

声明¶