Attaching documentation in Visual Studio (à la Eclipse)

Question

I am new to Visual Studio (2012) and came from using Eclipse, I miss the opportunity to hover over the method and get a dialog with detailed parameters and any accompanying comments.

In this particular example, I am using the OpenGL SDK with C ++ in Visual Studio, and I would like to be able to quickly get the documentation without going between VS and http://www.opengl.org/sdk/docs/man/ .

Is there a way in which I can attach documentation so that I can view it from within Visual Studio itself without having to manually search?

Answer 1

visual studio does provide the functionality that you are looking for as a hint (instead of a dialogue) when you hang long enough (2-3 seconds). In order for this to work correctly and more useful, you will need functions that must be correctly documented in the code itself. For more information on how intellisense tooltip works, check out the following questions: How do I get the full intellisense tooltip tooltip?

Documenting C ++ / CLI library code for use with C # - best tools and methods?

By default, although intellisense will just display the comment above the function declaration or deninition (which ever comment more seems). It will take some time when you hover the function for the first time, so be patient and try again :)

Answer 2

you can enter the code 3 slash /// and visual studio automaticalli write an xml template for documentation of the method / class / property.

Then you can enter the project properties. Create tab, Output section, XML documentation file, and enter a file name. It will be built on every build of the project.

You can try NDOC or SandCastle if you don't mind using third-party tools.