c# - 从 C# 类库生成文档

Question

我开发了一个包含许多项目的 C# 类库。我将其用作跨多个不同项目的通用库。

许多不同的开发人员最近加入了该团队，他们不熟悉该库，他们不确定其中包含什么。在 ghostdoc 的帮助下，我对它进行了很好的评论。

是否可以使用库的任何工具自动生成文档？我想针对它运行一个工具，它会为我生成文档，我可以让开发人员知道要阅读。我认为这样的工具会根据评论生成文档。

score 4 · Accepted Answer

我建议使用Sandcasle Help File Builder从源代码生成文档。您将需要查看XML 文档注释，因为生成的文档的质量和稳健性与您使用的 XML 注释的丰富性直接相关。

SHFB 可以生成 HTML 和/或编译的帮助文档。

score 2 · Accepted Answer

如果您使用的是 Visual Studio，请转到项目的属性，选择构建，然后在输出下勾选 XML 文档文件复选框。

score 1 · Accepted Answer

我最近制作了一个简单易用的库，可以从 C# 代码生成 markdown 文档。所需要的只是一个类库 dll 文件。
如果您想尝试一下，这里有一个链接，说明如何开始使用它，并附有生成文档的示例。

3 回答 3