352 字
2 分鐘
SSMS 每次寫 SQL 都在補註解？用 Code Snippet 一鍵生成
結論
- 用 SSMS Code Snippet 建立註解模板，輸入
cmt就能快速產生完整 SQL 註解結構。
適合用在哪裡
- 團隊需要統一 SQL 註解格式
- 常寫 Stored Procedure / Script
- 想減少重複貼模板的時間
- 想提升 SQL 可讀性與維護性
流程步驟
1. 建立 Snippet 檔案
- 將 XML 存成
.snippet檔，放到指定路徑 - 路徑：
C:\\Users\\@User\\Documents\\SQL Server Management Studio 21\\Code Snippets\\SQL\\My Code Snippets- SSMS 會自動讀取這個資料夾內的 snippet（重開 SSMS 才會生效）
2. 設定 Snippet 結構
- 定義標題、快捷鍵（Shortcut）、變數（Literal）
- Shortcut 設為
cmt，之後輸入 cmt + Tab 直接展開 - 變數像
$author$、$date$可快速填值
<CodeSnippets xmlns="<http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet>"> <CodeSnippet Format="1.0.0"> <Header> <Title>SQL-Comment</Title> <Shortcut>cmt</Shortcut> <Description>SQL-Comment</Description> <Author>J</Author> </Header>
<Snippet> <Code Language="SQL"><![CDATA[-- =============================================-- Author: $author$-- Create Date: $date$-- Description: $desc$-- =============================================/* Parameter: $param$
SQL: $sql$
Log: $log$*/]]></Code>
<Declarations> <Literal> <ID>author</ID> <Default>YourName</Default> </Literal>
<Literal> <ID>date</ID> <Default>yyyy/MM/dd</Default> </Literal>
<Literal> <ID>desc</ID> <Default>Description</Default> </Literal>
<Literal> <ID>param</ID> <Default>@Param Comment</Default> </Literal>
<Literal> <ID>sql</ID> <Default>SQL Sample</Default> </Literal>
<Literal> <ID>log</ID> <Default>yyyyMMdd by YourName - adjustment notes</Default> </Literal> </Declarations> </Snippet> </CodeSnippet></CodeSnippets>3. 使用 Snippet
- 在 SSMS Query 視窗輸入：
cmt- 按
Tab→ 自動展開模板 - 再用
Tab在各欄位間切換填值
補充
- SSMS 不會即時 reload Snippet → 一定要重開
- Shortcut 衝突時會無法展開（建議用簡短但不常見的名稱）
- 可建立多個 snippet（例如：sp、select、log 模板）
指令 / 範例整理
Click to expend
- 展開 snippet：
cmt + Tab收尾
- 懶不是問題，重複寫才是，Snippet 幫你把時間偷回來。
SSMS 每次寫 SQL 都在補註解？用 Code Snippet 一鍵生成
https://joyceowo.github.io/posts/32da78ea09fa80e095dff8f2f76f31f7/