vb.net - automatic XML comments - ''' -- Can I change the automatic defaults?

Question

I'm using Visual Studio 2008 SP1

in VB.NET, when I type ''' above a function, some automatic default XML comments appear:

''' <summary>
''' 
''' </summary>
''' <remarks></remarks>

I would like this to be the following instead:

''' <summary></summary>
''' <remarks></remarks>

Is there a way to change what appears when you type ''' above a function?

[This answer](http://stackoverflow.com/questions/369116/change-default-xml-comment-snippet-in-visual-studio/369125#369125) says there's a way. I've asked for input here. — Mark Hurd, Aug 13 '10 at 16:44

score 3 · Accepted Answer · answered Aug 14 '10 at 13:35

3

They key is in the VBXMLDoc.xml file. It provides templating for all of the XML comments in VB.NET. Still have not checked if there is a solution for C#. I went so long in wanting it for C#, but have actually just gotten used to the ugly default format.

How to Customize the XML Comments that are inserted by the Visual Basic Code Editor?

answered Aug 14 '10 at 13:35

Joseph Ferris

12,576
3
46
72

+1 It is a pity it is XML tags only though. Even some whitespace would be good. – Mark Hurd Aug 15 '10 at 05:14
1

This has worked fine up to and including VS2013. [New question](http://stackoverflow.com/q/32287626/256431) for VS2015. – Mark Hurd Sep 17 '15 at 08:27

score 2 · Answer 2 · answered Oct 22 '09 at 22:26

At my last place we wrote a VBA macro to insert the remarks for us and then bound it to a hotkey. This allowed us to write ouw own custom comment blocks with additional parameter and a good deal of the information already present.

Check out this article for the full details: http://msdn.microsoft.com/en-us/magazine/cc163757.aspx

score 1 · Answer 3 · answered Nov 10 '09 at 06:59

1

use GhostDoc! :-)

answered Nov 10 '09 at 06:59

zahi

11
1

vb.net - automatic XML comments - ''' -- Can I change the automatic defaults?

3 Answers3

Linked