2

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?

1
  • This answer says there's a way. I've asked for input here. Commented Aug 13, 2010 at 16:44

3 Answers 3

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?

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

2 Comments

+1 It is a pity it is XML tags only though. Even some whitespace would be good.
This has worked fine up to and including VS2013. New question for VS2015.
2

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

Comments

1

use GhostDoc! :-)

Comments

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.