Visua Studio代碼段基礎知識

描述:

　　代碼段是使用上下文菜單命令或者熱鍵（hotkeys）的組合在代碼文件中插入的可重用的代碼。它們可以插入整個類或方法。能夠提高我們開發的效率，節約時間。

       Visual Studio自帶了一些常用的代碼段，比如在C#中，插入指定的代碼段。就以try finaly爲示例。

       首先在類中輸入tryf,然後連接點擊兩次Tab鍵。就會自動生成try finally代碼段。如圖：                       

創建代碼段

       創建代碼段必須是XML文件，可以根據創建的代碼段文件修改相應的元素和增加一些元素。最後把製作完成的代碼段導入到我們的Visual Studio中。

       首先我們先來創建一個代碼段文件，選中項目，右擊添加-新建項-選擇XML文件，這個時候給XML文件起一個名字，同時把後面的.xml後綴名修改成. 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>
    </Header>
    <Snippet>
      <Code Language="">
        <![CDATA[]]>
      </Code>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>

 

Header：

       首先我們來看一下Header元素，我們模板默認只有一個Title子元素。實際上Header裏面有很多子元素（參考http://msdn.microsoft.com/zh-cn/library/ms171428.aspx）。

Title元素指的是標題，現在設置一個文本值“代碼段示例”。

<Title>代碼段示例</Title>

      我們還可以對header元素裏面在增加一些子元素，比如Author(作者)、Description（描述）和Shortcut（快捷鍵）。Shortcut在這特別講解一下，Shortcut可以作爲插入代碼段的快捷方式，如果我們Shortcut元素的文本值設置了EX，要把此代碼段輸出，在代碼編輯器中輸入EX，然後連按兩次Tab就能顯示剛纔定義好的代碼段了。特別注意下Shortcut元素的文本值只能包含字母數字字符、連字符 ( - ) 和下劃線 ( _ )。

  <Header>

      <Title>代碼段示例</Title>

      <Author>Mr Lee</Author>

      <Description>這個是用來演示代碼段的創建。</Description>

      <Shortcut>EX</Shortcut>

</Header>

Header還有不少子元素，您可以按上面提供的鏈接去研究。

Snippet:

       這個時候Header元素設置可以滿足我們一般的需求了，現在爲snippet元素設置一些信息。

       首先要設置我們代碼段要在哪個語言中使用，在這主要以C#爲主，這個時候Code元素的Language要設置爲CSharp。

<Code Language="CSharp">

       其它語言請參考: http://msdn.microsoft.com/zh-cn/library/ms171421.aspx

<![CDATA[]]>：

       這個時候，我們可以定義一些我們想輸出的文本值了。在<![CDATA[]]>裏面設置。

<Snippet>

      <Code Language="CSharp">

        <![CDATA[

        Response.Write("一個簡單的代碼段完成了。");

        ]]>

      </Code>

</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>

      <Author>Mr Lee</Author>

      <Description>這個是用來演示代碼段的創建。</Description>

      <Shortcut>EX</Shortcut>

    </Header>

    <Snippet>

      <Code Language="CSharp">

        <![CDATA[

        Response.Write("一個簡單的代碼段完成了。");

        ]]>

      </Code>

    </Snippet>

  </CodeSnippet>

</CodeSnippets>

 

添加代碼段到Visual Studio

1. 在Visual Studio菜單欄上面選擇工具-代碼段管理器。如圖：

 

導入代碼段之前，語言選項請選擇Visual C#。

1. 這個時候選擇我們要把代碼段導入到哪個文件夾，我比較傾向於系統已經建好的My Code Snippets文件夾，您可以自己添加一個新的文件夾。選中文件夾，點擊導入按鈕。找到您代碼段文件存放的路徑，然後打開，點擊完成按鈕，最後點擊確定按鈕。這個時候我們已經完成代碼段的導入了。現在可以使用這段代碼段了。
2. 在代碼編輯器中輸入EX（這個是我們設置的快捷方式），然後連續按兩下Tab鍵，您應該可以看到代碼中插入的Response.Write("一個簡單的代碼段完成了。");。

提示

解釋下剛纔上面設置的標題、作者和描述在哪可以看到。

1. 在輸入EX後，智能提示會看到我們的標題和描述。如圖：

 

1. 在代碼段管理器中可以看到，選擇我們存入代碼段的文件夾，選中我們剛纔的代碼就會在右邊窗口看到描述、快捷鍵和作者信息。如圖

 

參考：http://msdn.microsoft.com/zh-cn/library/ms165392.aspx