开发者

Visual Studio 2010: How to generate documentation out of code comments? [duplicate]

开发者 https://www.devze.com 2023-02-16 22:28 出处:网络
This question already has answers here: How do I export the code documentation in C# / VisualStudio 2008?
This question already has answers here: How do I export the code documentation in C# / VisualStudio 2008? (7 answers) 开发者_如何学JAVA Closed 8 years ago.

I wrote some comments for my code. Now how can I generate a documentation or something similar with Visual Studio 2010?


In your build properties tab, enable XML documentation and use Sandcastle to build a help/documentation file.


I describe a Tool for visual studio

VSdocman - Visual Studio code commenter and documentation generator

Document your .NET code on a professional level.

Generate comprehensive MSDN-style class documentation for your C# and Visual Basic .NET projects, with custom topics, IntelliSense and F1 context sensitive help.

See how easy the code commenting can be with powerful comment templates and sophisticated WYSIWYG comment editor.

VSdocman is an ultimate API documenting tool for every Visual Studio developer - whether you create a class library, a component, a control, an application, a smart device or a web site (ASP .NET).

screenshot

Visual Studio 2010: How to generate documentation out of code comments? [duplicate]

Visual Studio 2010: How to generate documentation out of code comments? [duplicate]

Visual Studio 2010: How to generate documentation out of code comments? [duplicate]

Web Site


Using NDoc. The NDoc is outdated, but there is NDoc3. More alternatives


  1. With a project selected in Solution Explorer, on the Project menu, click Properties.
  2. Click the Build tab.
  3. On the Build page, select XML documentation file. By default, the file is created under the specified output path, for example, "bin\Debug\Projectname.XML".

How to: Generate XML Documentation for a Project


Another well known (external) system for generating documentation is doxygen


I have used Sandcastle Help File Builder along with Sandcastle. Sandcastle Help File Builder is a GUI for Sandcastle and takes away all your pain while using Sandcastle.

0

精彩评论

暂无评论...
验证码 换一张
取 消