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?
You can enable or disable particular IntelliSense features in the Options dialog box, under Text Editor > C/C++ > Advanced.
You can trigger IntelliSense in any editor window by typing Ctrl+Space or by typing a trigger character (such as the dot character (.)
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.
Note: We have several Preview features which are off by default and can be enabled through the Tools > Options > IntelliCode page.
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.
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