Always Adding Comments When Writing SQL in SSMS? Generate with Code Snippet in One Click

Conclusion#

Use SSMS Code Snippet to create a comment template; typing cmt will quickly generate a complete SQL comment structure.

Where It’s Useful#

Teams need to standardize SQL comment formats
Frequently write Stored Procedures / Scripts
Want to reduce time spent repeatedly pasting templates
Want to improve SQL readability and maintainability

Process Steps#

1. Create the Snippet File#

Save the XML as a .snippet file and place it in the specified path
Path:

1
C:\Users\@User\Documents\SQL Server Management Studio 21\Code Snippets\SQL\My Code Snippets

SSMS will automatically read snippets in this folder (requires SSMS restart to take effect)

2. Configure the Snippet Structure#

Define the title, shortcut (Shortcut), and variables (Literal)
Set the Shortcut to cmt; then, typing cmt + Tab will expand it directly
Variables like $author$ and $date$ allow for quick value filling

1
<CodeSnippets xmlns="<http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet>">
2
  <CodeSnippet Format="1.0.0">
3
    <Header>
4
      <Title>SQL-Comment</Title>
5
      <Shortcut>cmt</Shortcut>
6
      <Description>SQL-Comment</Description>
7
      <Author>J</Author>
8
    </Header>
9

10
    <Snippet>
11
      <Code Language="SQL"><![CDATA[
12
-- =============================================
13
-- Author:      $author$
14
-- Create Date: $date$
15
-- Description: $desc$
16
-- =============================================
17
/*  Parameter:
18
        $param$
19

20
    SQL:
21
        $sql$
22

23
    Log:
24
        $log$
25
*/
26
]]></Code>
27

28
      <Declarations>
29
        <Literal>
30
          <ID>author</ID>
31
          <Default>YourName</Default>
32
        </Literal>
33

34
        <Literal>
35
          <ID>date</ID>
36
          <Default>yyyy/MM/dd</Default>
37
        </Literal>
38

39
        <Literal>
40
          <ID>desc</ID>
41
          <Default>Description</Default>
42
        </Literal>
43

44
        <Literal>
45
          <ID>param</ID>
46
          <Default>@Param Comment</Default>
47
        </Literal>
48

49
        <Literal>
50
          <ID>sql</ID>
51
          <Default>SQL Sample</Default>
52
        </Literal>
53

54
        <Literal>
55
          <ID>log</ID>
56
          <Default>yyyyMMdd by YourName - adjustment notes</Default>
57
        </Literal>
58
      </Declarations>
59
    </Snippet>
60
  </CodeSnippet>
61
</CodeSnippets>

3. Use the Snippet#

In the SSMS Query window, type:

1
cmt

Press Tab → The template will expand automatically
Then use Tab to switch between fields and fill in values

Additional Notes#

SSMS does not reload Snippets in real-time → A restart is required
If there’s a Shortcut conflict, it won’t expand (recommend using a short but uncommon name)
You can create multiple snippets (e.g., sp, select, log templates)

Commands / Examples Summary#

Click to expend

Expand snippet:

1
cmt + Tab

Wrap-up#

Laziness isn’t the problem; repetitive writing is. Snippets help you reclaim your time.