Warning: file_get_contents(/data/phpspider/zhask/data//catemap/2/csharp/294.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
C# 从C类库生成文档_C#_Documentation_Documentation Generation - Fatal编程技术网

C# 从C类库生成文档

C# 从C类库生成文档,c#,documentation,documentation-generation,C#,Documentation,Documentation Generation,我开发了一个C类库,其中包含许多项目。我将它用作跨多个不同项目的公共库 许多不同的开发人员最近加入了这个团队,他们对这个库并不熟悉,他们不确定它包含了什么。在ghostdoc的帮助下,我对它进行了很好的评论 是否可以使用库中的任何工具自动生成文档?我想针对它运行一个工具,它将为我生成文档,我可以让开发人员知道如何阅读。我假设这样的工具会根据注释生成文档。如果使用Visual Studio,请转到项目的属性,选择“生成”,然后取消输出并勾选“XML文档文件”复选框。我建议使用从源代码生成文档。您将

我开发了一个C类库,其中包含许多项目。我将它用作跨多个不同项目的公共库

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


是否可以使用库中的任何工具自动生成文档?我想针对它运行一个工具,它将为我生成文档,我可以让开发人员知道如何阅读。我假设这样的工具会根据注释生成文档。

如果使用Visual Studio,请转到项目的属性,选择“生成”,然后取消输出并勾选“XML文档文件”复选框。

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


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

我最近制作了一个简单易用的库,可以从C代码生成降价文档。它只需要一个类库dll文件。 如果您想尝试一下,请结合生成的文档示例介绍如何开始使用它


更多信息:

看看这些问题——是的,我使用的是VS,这个输出将是什么?它将为项目生成XML文档文件。基于你的问题,我认为你想要像你在MSDN上看到的那样可读的文档。Sandcastle使用此XML文档生成人类可读的文档。下面是一个代码示例&相关生成的XML:为了使XML更具可读性,您可以应用XSL样式表或使用多种工具中的一种,请参阅。404在两个链接上都找不到!我再次公开了存储库。谢谢@DanielWilliams