为C#代码创buildhtml文档

我通常不做任何C#开发,所以请原谅我的noobness,但我目前正在一个C#项目和VisualAssist生成这些花哨/// <summary></summary>评论,我一直在使用它们logging我的代码。

我假设必须有一种方法来使用这个注释来创build一个像Doxygen或Javadoc完成的HTML文档。 我怎么做的?

Doxygen或Sandcastle帮助文件构build器是将XML文档提取为HTML(以及其他forms)外部文档的主要工具。

请注意,您可以将这些文档导出器与文档生成器结合起来 – 就像您发现的那样,Resharper有一些基本的帮助器,但是也有更高级的工具可以完成这个特定的任务,比如GhostDoc (用于带有XML文档的C#/ VB代码)或我的插件Atomineer Pro文档 (用于C#,C ++ / CLI,C ++,C,VB,Java,JavaScript,TypeScript,JScript,PHP,包含XML,Doxygen,JavaDoc或Qt文档的Unrealscript代码)。

在2017年,最接近Javadoc的东西可能是由Microsoft开发的DocFx ,它是Commmand-Line-Tool以及VS2017插件。

围绕边缘仍然有点粗糙,但看起来很有希望。

另一个select是Wyam ,它有一个适用于networking应用程序的文档配方。 看一个例子的蛋糕文档 。

上面的Visual Studio方法似乎不适用于Visual Studio 2013,但是我能够find所描述的checkbox,使用项目菜单并select我的项目(可能是子菜单上的最后一个项目)以进入对话框checkbox(在“生成”选项卡上)。

您可能感兴趣的网页: http : //msdn.microsoft.com/en-us/magazine/dd722812.aspx

您可以使用命令行编译器或通过Visual Studio接口生成XML文档文件。 如果使用命令行编译器进行编译,请使用options / doc或/ doc +。 这将生成与程序集相同的名称和path的XML文件。 要指定不同的文件名,请使用/ doc:file。

如果您正在使用Visual Studio界面,则会有一个设置来控制是否生成XML文档文件。 要设置它,请双击解决scheme资源pipe理器中的我的项目以打开项目devise器。 导航到编译选项卡。 find窗口底部的“生成XML文档文件”,并确保它被选中。 默认情况下这个设置是打开的。 它使用与程序集相同的名称和path生成XML文件。