Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Where do you put the function documentation so that it shows up on intellisense?

I'm writing a library and I want to put documentation in my functions so that it will show up in intellisense, kind of like how the intellisense for the built in functions shows descriptions for each of the parameters and for the function itself. How do you put the documentation in? Is it through comments in the function or is it in some separate file?

like image 850
Alex319 Avatar asked Jul 16 '09 14:07

Alex319


People also ask

How do I enable IntelliSense?

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

How do I add IntelliSense to Visual Studio?

You can trigger IntelliSense in any editor window by typing Ctrl+Space or by typing a trigger character (such as the dot character (.)

What is the function of IntelliSense in VB?

IntelliSense is a code-completion aid that includes a number of features: List Members, Parameter Info, Quick Info, and Complete Word. These features help you to learn more about the code you're using, keep track of the parameters you're typing, and add calls to properties and methods with only a few keystrokes.

How can I get IntelliSense in Visual Studio 2019?

Note: We have several Preview features which are off by default and can be enabled through the Tools > Options > IntelliCode page.


1 Answers

Use XML comments above the function signature.

    /// <summary>     /// Summary     /// </summary>     /// <param name="param1">Some Parameter.</param>     /// <returns>What this method returns.</returns> 

The GhostDoc plugin can help generate these for you.

like image 69
Brandon Avatar answered Sep 24 '22 10:09

Brandon