为C＃代码创建html文档

Question

我目前正在开发一个C＃项目，VisualAssist为我生成这些花哨的/// <summary></summary>评论，我一直在使用它们来记录我的代码。

我认为必须有一种方法可以使用这些注释来创建像Doxygen或Javadoc那样的HTML文档。我该怎么做？

Answer 1

Doxygen或Sandcastle help file builder是将XML文档提取为HTML（和其他形式）外部文档的主要工具。

请注意，您可以将这些文档导出程序与文档生成器结合使用 - 正如您所发现的，Resharper有一些基本的帮助程序，但是还有更多高级工具可以执行此特定任务，例如GhostDoc（用于带有XML文档的C＃/ VB代码）或我的插件Atomineer Pro Documentation（适用于C＃，C ++ / CLI，C ++，C，VB，Java，JavaScript，TypeScript，JScript，PHP，包含XML，Doxygen，JavaDoc或Qt的Unrealscript代码）文档）。

Answer 2

2017年，最接近Javadoc的东西可能DocFx由微软开发并作为Commmand-Line-Tool和VS2017插件。

它的边缘仍然有点粗糙，但看起来很有希望。

另一个替代方案是Wyam，其具有适用于净应用的文档配方。请查看cake documentation以获取示例。

Answer 3

此页面可能会让您感兴趣：http://msdn.microsoft.com/en-us/magazine/dd722812.aspx

  

您可以使用命令行编译器或Visual Studio界面生成XML文档文件。如果使用命令行编译器进行编译，请使用options / doc或/ doc +。这将生成一个与程序集名称相同且路径相同的XML文件。要指定其他文件名，请使用/ doc：file。

     

如果您使用的是Visual Studio界面，则会有一个设置来控制是否生成XML文档文件。要进行设置，请在解决方案资源管理器中双击我的项目以打开项目设计器。导航到“编译”选项卡。在窗口底部找到“生成XML文档文件”，并确保选中它。默认情况下，此设置已启用。它使用与程序集相同的名称和路径生成XML文件。

Answer 4

Visual Studio的上述方法似乎不适用于Visual Studio 2013，但是我能够使用“项目菜单”找到所描述的复选框并选择我的项目（可能是子菜单上的最后一项）以进入带有复选框的对话框（在“构建”选项卡上）。