5

I'm wondering if there is any shortcut in visual studio to generate automatic documentation for a method or class.

For example when I write a method:

public void MyFunction(int d)
{

}

I want generate the following structure:

    /// <summary>
    /// 
    /// </summary>
    /// <param name="d"></param>

3 Answers 3

11

This is what happens when you type /// above the method signature.

You can also install and use a documentation tool like GhostDoc that also adds some detail to the code documentation that it generates.

Sign up to request clarification or add additional context in comments.

3 Comments

so obvious that I couldn't find the answer anywhere :)
Great. Thanks for this. I used only "///" and had no idea about GhostDoc
unfortunately Visual Studio Express Edition doesn't support ad-ins so I cannot use GhostDoc
4

I use GhostDoc for this. Means you can right-click on a method and it will insert the comments. The main benefit is that it inserts some default comment text as well, which is very useful.

Comments

1

Take a look at my addin, Atomineer Pro Documentation. It's similar to GhostDoc, but is considerably more powerful and flexible.

Comments

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.