Menu
How can I generate documentation of my C# web application in Visual Studio 2012, like Eclipse does?
937
From the menu bar, choose Tools > Options to open the Options dialog box. Then, navigate to Text Editor > C# (or Visual Basic) > Advanced. In the Editor Help section, look for the Generate XML documentation comments option.
XML Documentation helps other programmers or developers to use your code (classes, functions and their members) easily by providing some useful information. XML Documentation starts with three slashes before the class or function to be documented.
The syntax for adding XML comments in your code is triple slashes /// followed by one of the supported XML tags.
Any text between <! -- and --> characters is considered as a comment.
In Visual Studio go to tools menu -> extension manager... then in extension manager click on online gallery (on the left), then type in the top right search box the text... ghostdoc It's a very nice document helper.
162
You can comment your code using xml comments
/// <summary>
/// This class performs an important function.
/// </summary>
and then generate xml documentation after compiling the /doc. Here is the source: http://msdn.microsoft.com/en-us/library/b2s063f7.aspx
also I advixe you to use Sandcastle with its Help File Builder which is a very powerful tool: http://shfb.codeplex.com/
33
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
