CODEWITHSUNDEEP
c#visual-studio-2010commentsxml-comments
VoodooChild
VoodooChild

Reputation: 9784

Comment template in VS2010

I have inherited an API which doesn't have proper comments, and I am working on changing that.

Anyone know if there is some sort of mechanism to add a default XML comments to all the members of a class or an assembly? (I remember seeing something like that on a webcast and I think he might have used PowerShell script to achieve that.)

This way I can avoid lots of repetitive steps, and have everything in place to go and start writing just the comments.

Anyone has any better suggestions?

Upvotes: 2

Views: 638

Answers (2)

griegs
griegs

Reputation: 22760

I've found GhostDoc to be pretty good.

Once you've run it over your code you then simply add details where required.

http://submain.com/products/ghostdoc.aspx

Upvotes: 3

Ryan Stecker
Ryan Stecker

Reputation: 818

GhostDoc is pretty fantastic for XML documentation, although you'll need to purchase a copy to generate automatic documentation for all classes/members. The free version allows you to right click (or use a hotkey) on class or member and it will generate the documentation.

Upvotes: 3

Related Questions