Doxygen或Sandcastle help file builder是将XML文档提取为HTML(和其他形式)外部文档的主要工具。 请注意,您可以将这些文档导出器与文档生成器结合起来-正如您所发现的,Resharper有一些基本的帮助工具,但也有更高级的工具来完成这一特定任务,例如GhostDoc(对于C#/VB代码和XML文档)或我的插件Atomineer Pro Documentation(适用于C#、C++/CLI、C++、C、VB、Java、JavaScript、TypeScript、JScript、PHP、包含XML的Unrealscript代码、Doxygen、JavaDoc或Qt文档)。
5条答案
按热度按时间dgsult0t1#
Doxygen或Sandcastle help file builder是将XML文档提取为HTML(和其他形式)外部文档的主要工具。
请注意,您可以将这些文档导出器与文档生成器结合起来-正如您所发现的,Resharper有一些基本的帮助工具,但也有更高级的工具来完成这一特定任务,例如GhostDoc(对于C#/VB代码和XML文档)或我的插件Atomineer Pro Documentation(适用于C#、C++/CLI、C++、C、VB、Java、JavaScript、TypeScript、JScript、PHP、包含XML的Unrealscript代码、Doxygen、JavaDoc或Qt文档)。
rmbxnbpk2#
在2017年,最接近Javadoc的东西可能是DocFx,它由微软开发,作为Commmand-Line-Tool以及VS 2017插件。
它的边缘仍然有点粗糙,但它看起来很有希望。
另一种选择是Wyam,它有一个适合网络应用的文档配方。以cake documentation为例。
o2g1uqev3#
您可能感兴趣的页面:http://msdn.microsoft.com/en-us/magazine/dd722812.aspx
可以使用命令行编译器或通过Visual Studio界面生成XML文档文件。如果使用命令行编译器进行编译,请使用选项/doc或/doc+。这将生成一个与程序集同名且路径相同的XML文件。要指定其他文件名,请使用/doc:file。
如果使用的是VisualStudio界面,则有一个设置控制是否生成XML文档文件。若要设置它,请在解决方案资源管理器中双击“我的项目”以打开项目设计器。导航到“编译”选项卡。在窗口底部找到“GenerateXML documentationfile”,并确保选中该文件。默认情况下,此设置处于启用状态。它使用与程序集相同的名称和路径生成XML文件。
yptwkmov4#
Visual Studio的上述方法似乎不适用于Visual Studio 2013,但我能够使用项目菜单找到所描述的复选框,并选择我的项目(可能是子菜单上的最后一项)以进入带有复选框的对话框(在Build选项卡上)。
dsf9zpds5#
我找到了一个叫做“vsxmd”的东西,它可以为你做这个。
它从上面Kevin林赛的回答中提到的XML文档自动生成markdown。
首先,在Visual Studio(我使用的是2022)中,右键单击您的项目并选择属性。转到Build->Output,选中“Documentation file”下标记为“Generate a file containing API documentation”的复选框。注意“XML documentation file path”下的输出路径,因为这是生成markdown的地方。
接下来,右键单击您的项目并选择Manage Nuget Packages。在搜索框中键入来自“www.example.com“的“Vsxmd”nuget.org作为包源。
接下来构建你的项目,markdown文档将被放置在上面提到的文件夹中。
有关Vsxmd的更多信息,请参见https://github.com/lijunle/Vsxmd
如果你想将Markdown转换为HTML或其他东西,你可以使用stackedit.io或其他类似工具。我认为Markdown可能是代码文档的最佳选择,因为它得到了所有Git的支持,如Github,Bitbucket等。