Visual Studio 代碼片段功能(C#)

在VS編輯器里寫C#代碼的時候,如果你敲一個foreach,然后敲一下Tab鍵,VS就會自動幫我們補全代碼:

   foreach (var item in collection)
   {
       
   }

打開VS的代碼管理器:工具->代碼片段管理器,如下圖所示:

代碼片段管理器

Visual Studio默認已經給我們寫了好多代碼片段了,如果你覺得這些代碼片段不夠用,想自定義一個代碼片段的話,步驟如下:

編輯代碼片段

新建一個代碼片段文件,```注:代碼片段是xml文件,以.snippet為后綴名``,比如我自定義了一個代碼片段,文件名是bpr.snippet,右擊該文件,在編輯器中打開進行編輯:

<?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>bpr</Shortcut>
            <Description>獲取產品響應實體的代碼片段</Description>
            <Author>心徹</Author>
            <SnippetTypes>
                <SnippetType>Expansion</SnippetType>
                <SnippetType>SurroundsWith</SnippetType>
            </SnippetTypes>
        </Header>
        <Snippet>
          <Imports>
            <Import>
              <Namespace></Namespace>
            </Import>
          </Imports>
          <References>
            <Reference>
              <Assembly></Assembly>
            </Reference>
          </References>
          <Declarations>
            <Literal>
              <ID>name</ID>
              <ToolTip>銷售一體化DSF調用</ToolTip>
              <Default>MyTestMethod</Default>
            </Literal>
              <Literal Editable="false">
                <ID>TestMethod</ID>
                <Function>SimpleTypeName(global::Microsoft.VisualStudio.TestTools.UnitTesting.TestMethod)</Function>
              </Literal>
          </Declarations>
          <Code Language="csharp">
                  <![CDATA[
          /// <summary>
          /// 方法功能描述
          /// </summary>
          /// <param name="request">The request.</param>
          /// <returns></returns>
          public ProductBaseResponse<XXX> GetPromotion(BaseRequest request)
          {
                if (request == null)
                {
                    return new ProductBaseResponse<XXX> { ResCode = (int)ResultCode.PE_請求參數錯誤, ResMsg = "請求信息不能為空" };
                }               
                return ClientWrap.Action<ProductBaseResponse<XXX>>(Enum.ServiceGroupEnum.XXX, request, null).Result();
              $end$
          }]]></Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

保存。

導入自定義代碼片段

在代碼片段管理器中選中你要導入的文件夾,點擊“導入”按鈕,選擇你剛才編輯的代碼片段文件,確認即可。

使用自定義代碼片段

在VS代碼編輯器里輸入bpr,然后敲一下Tab鍵,則會自動補全你在代碼片段里寫的代碼啦。

節點說明

  • <Title>表示此代碼片段的標題
  • <Shortcut>快捷方式
  • <Description>對代碼片段的描述
  • <SnippetTypes>可以包含多個<SnippetType>,但其取值只有三種:Expansion、SurroundsWith、Refactoring。
    Expansion允許代碼插入在光標處;
    SurroundsWith允許代碼圍繞在選中代碼兩邊;
    Refactoring指定了C#重構過程中所使用的Snippet,在自定義Snippet中不能使用。如果該值不做設置,則Snippet可以放在任何地方。
    <Snippet>節點是實現代碼管理的地方,其包含四個子節點<Code><Declarations><Imports><References>
    1.<Code>
    包含<![CDATA[]]>中,放置模版代碼,此節點設置Language(C# VB XML),Kind(類型:如方法體,方法聲明),Delimiter(分隔符,默認值是$)
    2.<Declarations>
    包含多個<Literal>和<Object>節點,<Literal>用于指定文本值<Object>用于聲明模版對象。筆者自理解為一個函數。以便code調用.
    3.<Imports>
    引入命名空間,只支持vb . - -#.
    4.<References>
    添加程序集引用,只支持vb . - -#.

參考:Visual Studio 的代碼片段(Code Snippet)功能
擴展:Silverlight Code Snippets for DependencyProperties and other Handy Stuff

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,406評論 6 538
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,034評論 3 423
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 177,413評論 0 382
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,449評論 1 316
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,165評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,559評論 1 325
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,606評論 3 444
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,781評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,327評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,084評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,278評論 1 371
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,849評論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,495評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,927評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,172評論 1 291
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,010評論 3 396
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,241評論 2 375

推薦閱讀更多精彩內容