如何使用 XML 注释和 Doxygen 记录 C# 项目/程序集？答案

【问题标题】：How to document C# projects/assemblies with XML comments and Doxygen?如何使用 XML 注释和 Doxygen 记录 C# 项目/程序集？
【发布时间】：2013-04-27 17:20:21
【问题描述】：

我有一个带有 XML cmets 的 C# 代码库，并且 (owing to this site) 发现 Doxygen 可以轻松地将代码和 cmets 生成 HTML 和 PDF 文档所以我知道如何记录类和其他类型及其内容。

但是如何记录项目/程序集/命名空间？我的代码库有 50 多个；他们的职责必须记录在案。

我也更愿意在它们上使用 XML cmets。但是Microsoft's XML commenting manual 并没有给我一个线索，我在 Doxygen 文档中也找不到任何线索。

我错过了什么？您如何为您的 C# 项目/程序集提供文档？

更新：我现在知道how to do it with SHFB。

【问题讨论】：

标签： c# visual-studio doxygen .net-assembly xml-comments

【解决方案1】：

我们也一直在为我们的程序集生成文档。我们有大约 20-25 个 dll。我们使用了 Sandcastle [SHFB]，它是小菜一碟。我们使用了以下程序。

检查项目属性 [ClassLibrary] 中的XML Documentation file，然后根据需要提供自定义路径，否则将在 bin\debug 或 bin\release 文件夹中生成 XML。
然后我们将从 SandCastle 启动 GUI
然后我们将所有必备的 dll 文件放在一个文件夹中，然后我们将指向 UI 中的 dll 和 xml 文件，然后我们将构建应用程序。这将生成 CHM 以及网页，您可以使用这些网页作为网络帮助在网络上发布。

谷歌搜索一下肯定也会给你基于屏幕截图的示例......

如果您只需要使用 doxygen，请参考here

【讨论】：

非常适合阅读，我在输入问题时已经在安装 SHFB，所以我一定会尝试一下。但是我没有看到我的问题的答案：您如何指定项目本身的文档？
您只需选中Project Properties > Build > XML Documentation file 中的复选框即可生成XML 文档。也可以参考：broadcast.oreilly.com/2010/09/…
我不认为你理解我的问题，我不知道如何改写它以使其清楚。
同时，我尝试了 SHFB，它确实为我提供了一种方法来指定我使用过的项目/程序集本身的文档。我唯一剩下的愿望是 Doxygen 也会使用这些信息。
sandcastle 适合 Visual Studio 2017 还是现在有替代方案？ +1