Automatically generate XML-Documentation

Question

I'm not quite sure if this is possible, but I was wondering if Visual Studio 10 (2010) or 11 (2012) allows you to automatically generate an XML compliant documentation?

For example, in visual studio, if you are using the programming language C#, when you create a method, and type 3 forward slashes / - it generates a comment above the method with a place to fill in a summary, and descriptions for all parameters.

Example:

/// <summary>
/// 
/// </summary>
/// <param name="value1"></param>
/// <param name="value2"></param>
/// <returns></returns>
public int GetSum(int value1, int value2);

If not, is there an extension/tool that allows for doing so?

albert · Accepted Answer · 2019-01-27 14:15:20Z

2

Yes, it's called doxygen and this style of comments are actually called "doxygen-comments".

edited Jan 27, 2019 at 14:15

albert

9,2003 gold badges24 silver badges42 bronze badges

answered Dec 21, 2012 at 21:15

hate-engine

2,37018 silver badges26 bronze badges

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

1 Comment

TheAJ Over a year ago

I'm aware of this, but is there a tool that actually places a "fill-in" commenting template? Like what visual studio does for C# applications

Ahuman · Accepted Answer · 2013-06-18 17:57:16Z

1

I know this is a old thread. But if someone is still looking for this, ghostdoc is what you need http://submain.com/products/ghostdoc.aspx

answered Jun 18, 2013 at 17:57

Ahuman

7627 silver badges18 bronze badges

Collectives™ on Stack Overflow

Automatically generate XML-Documentation

2 Answers 2

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related