Change default XML comment snippet in Visual Studio

Question

When I hit /// in Visual Studio, is it possible to change the resulting snippet from this:

/// <summary>
/// 
/// </summary>

to this?:

/// <summary></summary>

Reading this question in 2019, it is misleading because since VS2015(?) /// does not simply print /// <summary></summary> but also template elements for each parameter, generic type, and return value. If you are looking for that kind of customization keep on searching... — Jack Miller
– Jack Miller, Commented Jul 10, 2019 at 6:51

Valamas · Accepted Answer · 2012-01-21 02:57:17Z

18

Here is the solution working in at least VS2010.

Save the bottom code as a file summ.snippet.
Visual Studio 2010 / Tools / Code Snippet Manager
Click import, browse to file. Save with default options.

Now goto your code window and type summ + tab + tab

Result

/// <summary>  </summary>

with the cursor in the middle of the tag, ready to type.

Here is the contents of the summ.snippet

<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">

    <CodeSnippet Format="1.0.0">
        <Header>
                <Title>Summary - inline</Title>
                <Description>Created inline summary comment tag</Description>
                <Author>Mike Vanderkley</Author>
                <Shortcut>summ</Shortcut>
                <SnippetTypes>
                        <SnippetType>Expansion</SnippetType>
                </SnippetTypes>
        </Header>
        <Snippet>
            <Code Language="csharp">
                <![CDATA[/// <summary> $end$ </summary>]]>
            </Code>
    </Snippet>
  </CodeSnippet>

</CodeSnippets>

edited Jan 21, 2012 at 2:57

answered Apr 7, 2011 at 0:35

Valamas

24.8k25 gold badges111 silver badges181 bronze badges

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

3 Comments

Daniel Schaffer Over a year ago

Clever! I'd still prefer to be able to use the standard /// shortcut, but this is far better than clearing up the linebreaks manually.

Valamas Over a year ago

The summ keyword starts to work after a while and you will forget all about the ///. I noticed that some of the attributes were missing having pasted in stackexchange. The version showing is now the correct version. Recommend re-importing and overwriting the old version.

NTR Over a year ago

This still works (VS2015). Changed xmlns 2005 to 2015. Also works in vb changing /// to ''' and "csharp" to "vb". Thanks

Mark.Goldberg · Accepted Answer · 2011-09-09 20:33:05Z

9

It appears to me that what the /// generates is coded in: Macros.Samples.Utilities.InsertDocComments

answered Sep 9, 2011 at 20:33

Mark.Goldberg

911 silver badge1 bronze badge

3 Comments

pithhelmet Over a year ago

This is the correct location to answer the question as it was asked.

John Saunders Over a year ago

Then I wonder how it could be changed in VS2013, which no longer supports macros.

Dominic Jonas Over a year ago

Cannot find this location in VisualStudio 2017. Do you now where I must look?

Joseph Ferris · Accepted Answer · 2008-12-15 17:33:10Z

4

I know that it was possible for VB in VS 2005 and VS 2008. Last I had checked, though, there was not a way to do it for C#, sadly. That has been a pet peeve of mine for some time, now.

answered Dec 15, 2008 at 17:33

Joseph Ferris

12.7k3 gold badges49 silver badges73 bronze badges

3 Comments

Joseph Ferris Over a year ago

Sadly, it has become a habit of mine to just go in and change it when it is inserted. It is almost like I do it on autopilot now. Not sure if any third-party apps or add-ins address this or not.

Daniel Schaffer Over a year ago

Yeah, I've been doing it manually, and I don't want to run a 3rd party app or add-in just for this. Thanks!

Mark Hurd Over a year ago

How do you do this in VB? This question wants to know.

Collectives™ on Stack Overflow

Change default XML comment snippet in Visual Studio

3 Answers 3

3 Comments

3 Comments

3 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

3 Comments

3 Comments

3 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related