VS 2022 类库项目的文档工具

Question

您好，请推荐任何可以与 VS2022 集成的文档工具，用于在 Framework 4.7.2 中构建的类库项目。

或者请推荐任何其他可以根据代码生成文档供客户参考且易于理解的工具。

比如招摇。

我已经尝试使用 doxygen 和 XML 注释工具。 类库项目不支持 Swagger（如果有）请帮忙解决。

Answer 1

以下是一些非常适合 .NET Framework 4.7.2 类库项目的文档工具，以及创建客户端友好文档的方法。

与 Visual Studio 2022 集成的工具

• Sandcastle 帮助文件生成器 (SHFB)：
• VSdocman
• 幽灵文档
• DocFX
• 恩斯瓦格

如何选择？

• 文档风格：您想要网站、传统帮助文件还是 Swagger UI？

• 技术专长：您是否熟悉 Markdown (DocFX) 以及 NSwag 可能的代码更改，或者您更喜欢纯 XML 注释方法

• 集成：您是否需要该工具来紧密集成到您的 Visual Studio 工作流程中？

注意事项

• 易于使用：VSdocman 和 GhostDoc 旨在在 Visual Studio 中快速设置。
• 所需输出：SHFB 对于传统的类似 MSDN 的帮助文件非常强大。用于网站的 DocFX。 NSwag 用于 Swagger/OpenAPI 定义。
• 预算：VSdocman 是商业的。其他是免费的或有免费版本。