如何使用XML注释和Doxygen为C#项目/程序集编写文档？

Question

我有一个带有XML注释的C#代码库，(由于这个网站)发现Doxygen可以轻松地将代码和注释转换为HTML和PDF文档，所以我知道如何记录类和其他类型及其内容。

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

我更喜欢在它们上面使用XML注释。但是Microsoft的XML注释手册没有给我任何提示，而且我在Doxygen文档中也找不到任何线索。

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

更新：我现在知道如何使用SHFB完成它。

- reinierpost

Answer 1

我们也一直在为我们的程序集生成文档。我们大约有20-25个dll文件。我们使用了Sandcastle [SHFB]，这很容易。我们采用了以下步骤。

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

稍微谷歌一下就能找到基于截图的示例...

如果您只想使用doxygen，请参考here。

- Saravanan

---

很高兴看到这篇文章，当我在打字提问的时候，我已经在安装SHFB了，所以我一定会尝试这个。然而，我没有看到我的问题的答案：如何在项目本身上指定文档？ - reinierpost

你只需在“项目属性>生成>XML文档文件”中勾选复选框，即可生成XML文档。此外，您还可以参考：http://broadcast.oreilly.com/2010/09/build-html-documentation-for-y.html - Saravanan

我不认为你理解我的问题，也不知道该如何重新表述以使其更清晰明了。 - reinierpost

与此同时，我已经尝试了SHFB，并且它确实为我提供了一种在项目/程序集本身上指定文档的方式，我已经使用过了。我唯一剩下的愿望是Doxygen也能使用这些信息。 - reinierpost

沙堡是否适用于Visual Studio 2017，或者现在有其他替代品？+1 - w0051977

也许可以尝试这个：https://stackoverflow.com/questions/8866598/good-alternatives-to-sandcastle-to-generate-msdn-style-documentation - Saravanan