为c#代码创建html文档
本文关键字:html 文档 创建 代码 | 更新日期: 2023-09-27 18:03:04
我目前正在做一个c#项目,VisualAssist为我生成了这些花哨的/// <summary></summary>
注释,我一直在使用它们来记录我的代码。
我想一定有一种方法可以使用这些注释来创建HTML文档,就像那些由氧或Javadoc完成的那样。我怎么做呢?
xygen或Sandcastle帮助文件生成器是将XML文档提取为HTML(和其他形式)外部文档的主要工具。
请注意,您可以将这些文档导出器与文档生成器结合使用-正如您所发现的,Resharper有一些基本的帮助器,但也有更高级的工具来完成此特定任务,例如GhostDoc(用于带有XML文档的c#/VB代码)或我的插件Atomineer Pro documentation(用于c#, c++/CLI, c++, C, VB, Java, JavaScript, TypeScript, JScript, PHP, Unrealscript代码,包含XML, Doxygen, JavaDoc或Qt文档)
在2017年,最接近Javadoc的东西可能是由微软开发的DocFx,作为命令行工具和VS2017插件。
它的边缘还有些粗糙,但看起来很有希望。
另一个选择是Wyam,它有一个适合于网络应用程序的文档配方。查看cake文档中的示例。
您可能感兴趣:http://msdn.microsoft.com/en-us/magazine/dd722812.aspx
您可以使用命令行编译器或通过Visual Studio界面生成XML文档文件。如果使用命令行编译器进行编译,请使用options/doc或/doc+。这将生成与程序集具有相同名称和相同路径的XML文件。要指定一个不同的文件名,使用/doc:file.
如果您使用的是Visual Studio界面,则有一个设置控制是否生成XML文档文件。要设置它,请在"解决方案资源管理器"中双击"我的项目"以打开"项目设计器"。导航到Compile选项卡。查找"生成XML文档文件"在窗口的底部,确保它被选中了。默认情况下,此设置是打开的。它使用与程序集相同的名称和路径生成一个XML文件。
上述Visual Studio方法似乎不适用于Visual Studio 2013,但我能够使用项目菜单找到所描述的复选框并选择我的项目(可能是子菜单上的最后一项)以进入复选框对话框(在Build选项卡上)。
我发现了一个叫" vsxmd"它会为你做这件事。
它从上面Kevin Lindsay的回答中提到的XML文档自动生成降价。
首先,在Visual Studio(我使用2022)中,右键单击您的项目并选择属性。转到Build->Output,选中"Documentation file"生成一个包含API文档的文件。注意"XML文档文件路径"下的输出路径;因为这是你的降价将产生的地方。
接下来,右键单击项目并选择Manage Nuget Packages。在搜索框中输入"Vsxmd"从"nuget.org"作为包源。
接下来构建您的项目,markdown文档将放在上面提到的文件夹中。
有关vsmd的更多信息,请参阅https://github.com/lijunle/Vsxmd
如果你想将Markdown转换为HTML或其他东西,你可以使用stackkedit。IO或其他类似的工具。我认为Markdown可能是代码文档的最佳选择,因为它得到了各种Git的支持,如Github、Bitbucket等。
从微软的文档中,他们接受XML文档输入(并生成输出文件)的工具列表(包括第三方)在https://learn.microsoft.com/dotnet/csharp/language-reference/xmldoc/#tools-that-accept-xml-documentation-input,目前包括DocFX, Sandcastle和Doxygen。(添加这个答案,因为我没有看到一个现有的链接到微软列表)