用途:为 .NET 项目生成与维护 API 文档,把源代码、XML 注释和 OpenAPI 规范转化为可浏览的文档站点。
主要能力:
- DocFX 设置:从 .NET 程序集和 XML 文档注释生成 API 参考,配置 docfx.json 的 metadata 与 build 段,支持元数据提取、模板定制和 uid 交叉引用。用 dotnet tool install -g docfx 或本地工具安装,用 docfx metadata docfx.json 提取 YAML,再 docfx build 生成 HTML。
- OpenAPI 作为文档:用 Scalar 或 Swagger UI 嵌入交互式文档,支持按标签分组、请求响应示例、认证配置和试用功能;可通过 AddDocumentTransformer 提供多版本 OpenAPI 文档(如 /openapi/v1.json 与 /openapi/v2.json),也可用 Microsoft.Extensions.ApiDescription.Server 在构建时导出规范供静态站点使用。
- 文档与代码同步:在 CI 中用 dotnet build -warnaserror:CS1591 强制 XML 文档完整性,用 docfx build docfx.json --warningsAsErrors 检测失效交叉引用,并用链接检查器校验站点内链接;在 PR 上运行仅验证不部署的文档构建。
- 变更日志模式:结构化记录破坏性变更、替代 API 与迁移步骤;用 [Obsolete] 标注弃用项并维护弃用跟踪表。
- 多版本文档:为不同主版本维护分支或标签,分别构建文档,并配置版本选择器与 URL 模式。
适用场景:发布 NuGet 库的 API 参考、为 ASP.NET Core 服务提供交互式 OpenAPI 文档、在持续集成中防止文档回退、维护跨主版本的文档与迁移指南。
限制与边界:本技能只负责从代码生成 API 文档的工具与流程。XML 注释语法与撰写规范、OpenAPI 规范生成与 Swashbuckle 迁移、文档站点 CI/CD 部署、文档平台选型、变更日志生成工具与 SemVer 版本策略,均属于其他技能范畴,本资料未提供这些内容。版本假设为 DocFX v2.x(社区维护)、OpenAPI 3.x(经 Microsoft.AspNetCore.OpenApi,.NET 9+ 内置)、Scalar UI、代码示例基线 .NET 8.0+。具体收费、价格、平台与效果资料暂未提供。