c# - 为 C# 代码创建 html 文档

Question

我目前正在处理一个 C# 项目，VisualAssist 为我生成了这些花哨/// <summary></summary>的注释，我一直在使用它们来记录我的代码。

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

Answer 1

Doxygen或Sandcastle 帮助文件构建器是将 XML 文档提取为外部文档的 HTML（和其他形式）的主要工具。

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

Answer 2

在 2017 年，最接近 Javadoc 的可能是微软开发的DocFx，它作为一个命令行工具和一个 VS2017 插件提供。

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

另一种选择是Wyam，它有一个适用于网络应用程序的文档配方。查看cake 文档以获取示例。

Answer 3

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

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

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

Answer 4

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