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

Question

我有一个带有XML注释的C#代码库,并且(由于这个站点)发现Doxygen可以很容易地生成转换代码和注释到HTML和PDF文档中所以我知道如何记录类和其他类型及其内容.

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

我也希望只对它们使用XML注释.但微软的XML评论手册并没有给我一个如何做到这一点的线索,我也找不到Doxygen文档中的任何线索.

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

更新:我现在知道如何使用SHFB.

Answer 1

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

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

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

如果您需要仅使用 doxygen，请参阅此处