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

Question

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?

Answer 1

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.