创建C＃代码

我目前工作的一个C＃项目，并VisualAssist产生对我来说这些花哨/// <summary></summary>意见HTML文档，我一直在使用他们做记录我的代码。创建C＃代码

我认为必须有使用这些意见，以创建像那些由Doxygen的或做的Javadoc HTML文档的方式。我怎么做？

2013-03-09 jaho

Doxygen也适用于C＃。它出什么问题了？ – Etan 2013-03-09 22:04:48

但Doxygen使用不同的语法。由于Visual Assist已经为我生成了这些评论，我宁愿使用它们。编辑：其实也许它支持XML，我会给它一个去。 – jaho 2013-03-09 22:07:29

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

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

来源

2013-03-09 22:37:53

-1

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

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

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

来源

2013-03-09 22:30:12 Recurve

+10

他不问如何生成XML文档，他问如何将该XML文档转换为HTML。 – Mark 2015-05-13 20:59:56

尽管你的回答没有回答OP的问题，但它回答了我的问题。谢谢！ – 2015-06-04 16:29:31

你可以尝试https://www.docify.net/他们做的正是这一点。

来源

2016-07-18 21:43:50 Josiah

该项目看起来不错，但注册链接被打破 – Nic 2016-09-28 08:56:34

该网站已关闭 – Josiah 2016-12-05 04:28:38

为Visual Studio上述方法似乎并不适用于Visual Studio的2013年，但我能找到使用Project菜单并选择我的项目（可能在子菜单中的最后一项）所描述的复选框去与复选框（在生成选项卡上）的对话框。

来源

2017-05-03 21:03:37

2017年，离Javadoc最近的东西可能是DocFx，它由微软开发，作为Commmand-Line-Tool以及VS2017插件。

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

另一种方法是Wyam具有适于净aplications一个文档配方。以cake documentation为例。

来源

2017-06-10 07:57:42 mode777

Docfx为我完美工作。我也为VS2015工作 - 只需添加nuget软件包'docfx。console'。 – 2017-07-21 08:21:43

最受赞赏的答案是从2009年开始，但今天（2017年）我会说docfx是最好的选择。 – 2017-08-03 05:57:05

DocFX不幸的是存在很大的缺点，它只关注公众的文档。所以如果你想为内部使用做一些文档，其中也包括访问修饰符“内部”或“私人”，这是绝对无用的。当然...你有机会自己修改代码并修复此问题。请参阅：https：//github.com/dotnet/docfx/issues/836 – Onsokumaru 2017-12-21 13:28:25

创建C＃代码

回答

相关问题