从C#类库生成文档

时间:2012-11-14 00:34:47

标签: c# documentation documentation-generation

我开发了一个包含大量项目的C#类库。我使用它作为跨多个不同项目的公共库。

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

是否可以使用库的任何工具自动生成文档?我想运行一个反对它的工具,它将为我生成文档,我可以让开发人员知道阅读。我认为这样的工具会从评论中生成文档。

3 个答案:

答案 0 :(得分:2)

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

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

答案 1 :(得分:1)

如果您正在使用Visual Studio,请转到项目的属性,选择Build,然后Uner Ouput勾选XML文档文件复选框。

答案 2 :(得分:0)

我最近创建了一个简单易用的库,它可以从C#代码生成markdown文档。所需要的只是一个类库dll文件。
如果您想尝试一下,here's a link如何开始使用生成的文档示例。

更多信息:https://www.nuget.org/packages/BetaSoftware.AutoDocumentation