qbnmfg
Last Updated: February 25, 2016
·
1.23K
· wowca

Visual Studio XML Comments

When working in a large team, of even alone (because you'll forget about most functions that you wrote 1/2 year ago) use quick XML comments.

It's super easy and it's really not much work, but Intellisense will show all the parameters and the description, when you're calling the function.

Just go to the line above your function and:

For C#: Use three slashes

For VB.net: Use three single apostrophes (')

After you do this, Visual Studio will automatically add a block of comments just above your function (e.g:)
Picture

Say Thanks
Respond

1 Response
Add your response

971

For the super lazy check out Ghost doc for handling the inserting of comments. Please note that these comments will almost always still need to be edited before they are actually useful.
http://submain.com/products/ghostdoc.aspx

over 1 year ago ·