创建C#代码的HTML文档 [英] Create html documentation for C# code

问题描述

我目前正在从事C#项目，VisualAssist为我生成了这些精美的/// <summary></summary>注释，并且我一直在使用它们来记录我的代码.

I'm currently working on a C# project and VisualAssist generates these fancy /// <summary></summary> comments for me and I've been using them do document my code.

我假设必须有一种使用这些注释来创建HTML文档的方法，就像Doxygen或Javadoc所做的那样.我该怎么办?

I assume there must be a way to use these comments to create HTML documentation like those done by Doxygen or Javadoc. How do I do that?

推荐答案

Doxygen 或

Doxygen or Sandcastle help file builder are the primary tools that will extract XML documentation into HTML (and other forms) of external documentation.

请注意，您可以将这些文档导出器与文档生成器结合使用-如您所见，Resharper有一些基本的帮助器，但是还有许多更高级的工具可以执行此特定任务，例如

Note that you can combine these documentation exporters with documentation generators - as you've discovered, Resharper has some rudimentary helpers, but there are also much more advanced tools to do this specific task, such as GhostDoc (for C#/VB code with XML documentation) or my addin Atomineer Pro Documentation (for C#, C++/CLI, C++, C, VB, Java, JavaScript, TypeScript, JScript, PHP, Unrealscript code containing XML, Doxygen, JavaDoc or Qt documentation).

这篇关于创建C#代码的HTML文档的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！