Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Visual studio c++ documentation generator [closed]

Tags:

Is there a way to get documentation(like javadoc) in a visual-c++ project?

I'm using visual studio 2010.

thanks!

like image 545
hara Avatar asked May 15 '10 14:05

hara


People also ask

How do I turn my IntelliSense back on?

You can enable or disable particular IntelliSense features in the Options dialog box, under Text Editor > C/C++ > Advanced.

How do you create a document in Visual Studio?

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.


1 Answers

You could use the XML-Documentation format, supported by VS2010, too. http://msdn.microsoft.com/en-us/library/ms177226%28VS.80%29.aspx

After commenting your code, you can use Sandcastle to create a MSDN-like documentation: http://sandcastle.codeplex.com/. (Here is a GUI representation for Sandcastle, which is a lot easier to use: https://github.com/EWSoftware/SHFB)

I use AtomineerUtils to create the XML-Documentation headers automatically. This tool will help you a lot. You can have free base version here: http://www.atomineerutils.com/products.php

like image 155
Simon Avatar answered Sep 21 '22 14:09

Simon