c# - 如何使用 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 中发布的网页作为 Web 帮助。

谷歌搜索一下肯定会为您提供基于屏幕截图的示例。

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