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?

Was it helpful?

Solution

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?

OTHER TIPS

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

use GhostDoc! :-)

Licensed under: CC-BY-SA with attribution
Not affiliated with StackOverflow
scroll top