脚本文档生成器 (Script Doc Generator) ⚡¶

通过反射分析 C# 类型信息，生成结构化的 API 文档，支持增量生成与个性化扩展。

标注 ⚡ 表示需要安装 Odin Inspector 才启用此编辑器工具。

使用场景¶

当你的团队、开源项目或个人项目需要一份 API 文档时——不仅需要自动生成的类型签名，还需要针对 API 补充个性化说明（使用示例、注意事项、业务上下文等）——Script Doc Generator 正是为此而设计的。它负责生成准确的 API 签名部分，你来补充那部分只有人才写得出的内容，两者互不干扰，增量更新。

核心优势¶

• 🔒 完全离线：基于 C# 反射机制运行，无需网络连接、无需外部 API、无需第三方服务。断网环境、内网开发、机密项目——随时随地可用。
• ⚡ 零等待：反射分析在毫秒级完成。选中类型，文档即现。没有进度条，没有等待。
• 🎮 与 Unity 一体：作为 Editor 原生扩展运行，直接在 Inspector 中操作。无需切换窗口、无需外部工具链——文档就在你编写代码的地方。
• ✏️ 增量生成：重新生成文档时，自动保留 ## 额外说明 标识符之后的手写内容，已有 Front Matter（YAML/TOML 头部）也会保留。自动生成的签名与人工补充的说明互不覆盖。
• 🤖 AI 友好：默认生成 Markdown 格式文档，结构清晰、语义明确，可直接用于构建 AI API 问答知识库（RAG、Embedding 等），让 AI 助手精准回答项目 API 相关问题。
• 🔧 可配置与可扩展：提供多种配置项与扩展接口，适配不同项目的文档需求。

功能详情¶

• 类型分析：支持类、结构体、接口、枚举、委托、Record 等类型的完整签名与特性解析，包含泛型约束、基类继承与接口实现。
• 字段解析：覆盖全部 C# 原始类型、集合类型、委托类型、特殊类型（abstract/dynamic/interface/nullable），以及 const/static 默认值、访问修饰符、复合关键字（const/static readonly/readonly）、Unity 内置类型与特性标注。
• 属性解析：支持 getter/setter 不对称访问修饰符（如 public get / private set）、静态属性、默认值初始化。
• 方法解析：支持泛型方法、参数默认值、params 可变参数、async 异步方法、运算符重载、扩展方法。
• 继承分析：识别 virtual/abstract/override 方法与接口实现，追踪继承链来源。
• 辅助功能：成员排序（DerivedMemberDataComparer）、方法重载标记、构造方法签名生成、事件签名生成。

可配置项¶

可扩展接口¶

单元测试覆盖¶

Script Doc Generator 目前已包含 153 个单元测试，覆盖各数据类型的签名生成功能：