我有一个带有 XML 注释的 C# 代码库，并且 ( owing to this site ) 发现 Doxygen可以轻松地将代码和注释生成为 HTML 和 PDF 文档，所以我知道如何记录类和其他类型及其内容。
但是如何记录项目/程序集/命名空间？我的代码库有 50 多个；他们的职责必须记录在案。
我也更愿意对它们使用 XML 注释。但是Microsoft's XML commenting manual没有告诉我如何执行此操作，而且我在 Doxygen 文档中也找不到任何线索。
我错过了什么？您如何为您的 C# 项目/程序集提供文档？
更新:我现在知道了how to do it with SHFB .
最佳答案
我们也一直在为我们的程序集生成文档。我们有大约 20-25 个 dll。我们使用过 SandcaSTLe [SHFB]，它是小菜一碟。我们使用了以下程序。
- 检查项目属性 [ClassLibrary] 中的
XML 文档文件，然后根据需要提供自定义路径，否则 XML 将在 bin\debug 或 bin\release 文件夹中生成。< - 然后我们将从 SandCaSTLe 启动 GUI
- 然后我们将所有先决条件 dll 文件放在一个文件夹中，然后我们将指向 UI 中的 dll 和 xml 文件，然后我们将构建应用程序。这将生成 CHM 以及可用于在网络上发布为网络帮助的网页。
谷歌搜索一下肯定也会给你基于屏幕截图的示例..
如果您只需要使用doxygen，请引用here
关于c# - 如何使用 XML 注释和 Doxygen 记录 C# 项目/程序集？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/16356630/