vs2017通過snippet代碼片斷進行标準化注釋

我們在進行團隊開發時，類的注釋已經可以做到自定義了，詳細看上篇文章《vs2017通過子產品檔案添加自定義注釋》，而對于方法的注釋，我們也需要完善一下，這裡我們用到了“代碼片斷”插件，VS裡有很多指令的縮寫，如for加兩次tab，ctor加兩次tab，事實上tab表示執行的意思，而前面的字母表示一個代碼片斷，我們可以把一些公用的代碼進行抽像，做成一個代碼片斷！

一打開代碼片斷對話架構,ctrl+K,ctrl+B

二把它自己封裝的代碼片斷檔案“導入”，然後重新開機VS，你的代碼片斷就可以使用了，下面看我的注釋功能的片斷

<?xml version="1.0" encoding="utf-8"?>
    <CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
        <CodeSnippet Format="1.0.0">
            <Header>
                <Title>方法标準注釋</Title>
                <Shortcut>rr</Shortcut>
                <Description>更新代碼注釋 的代碼片段</Description>
                <Author>lind</Author>
                <SnippetTypes>
                    <SnippetType>Expansion</SnippetType>
                </SnippetTypes>
            </Header>
            <Snippet>
                <Declarations>
                    <Literal>
                        <ID>Description</ID>
                        <ToolTip>功能</ToolTip>
                        <Default>更新描述</Default>
                    </Literal>
                    <Literal>
                        <ID>UpdatedBy</ID>
                        <ToolTip>更新人</ToolTip>
                        <Default>zzl</Default>
                    </Literal>
                    <Literal>
                        <ID>UpdatedDate</ID>
                        <ToolTip>日期</ToolTip>
                        <Default>@@Today</Default>
                    </Literal>
                </Declarations>
                <Code Language="csharp">
              <![CDATA[      
                ///<summary>
                /// 功能    :$Description$
                 /// 更新人  :$UpdatedBy$
                /// 更新時間:$UpdatedDate$
                ///</summary> $end$  ]]>
                </Code>
            </Snippet>
        </CodeSnippet>
    </CodeSnippets>

代碼中，Title是在對話框裡的說明資訊，Shortcut是編輯器裡輸入的快捷指令，如rr，再按兩次tab，就可以把自定義的注釋添加了！

添加後的效果

感謝各位的閱讀，有了這個功能，我們的代碼注釋就更加規範了！

作者：倉儲大叔，張占嶺，

榮譽：微軟MVP

QQ：853066980

支付寶掃一掃，為大叔打賞!