コード スニペットの作成

Visual Studio で開発する場合、使用頻度の高いコードの断片をコード スニペットとして事前に定義しておくと便利です。

例えば、パブリック メソッドでは引数の値が null でないことを検証するために、
次のようなコードを記述することがよくあります (C# の場合)。

---

public void Method1(string parameter1)
{
    if (parameter1 == null)
    {
        throw new ArgumentNullException("parameter1");
    }

    ・・・ (以下省略) ・・・
}

---

そこで、以下では この if 節のコード ブロックをスニペットとして作成します。

Visual Studio 2010 の既定のコード スニペットは
「%ProgramFiles%\Microsoft Visual Studio 10.0\VC#\Snippets\1041\Visual C#」フォルダーに格納されているので、
それらを参考にするとよいでしょう。

では、コード スニペットの作成手順を以下に示します。

1. 次の内容を UTF-8 でファイルに保存する。ファイル名を argnull.snippet とする。
   

   ---

   <?xml version="1.0" encoding="utf-8"?>
   <CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2008/CodeSnippet">
     <CodeSnippet Format="1.0.0">
       <Header>
         <Title>argnull</Title>
         <Shortcut>argnull</Shortcut>
         <Description>null でないことを検証するためのコード スニペット</Description>
         <Author>(作者名)</Author>
         <SnippetTypes>
           <SnippetType>Expansion</SnippetType>
         </SnippetTypes>
       </Header>
       <Snippet>
         <Declarations>
           <Literal>
             <ID>parameter</ID>
             <ToolTip>引数の名前</ToolTip>
             <Default>parameter</Default>
           </Literal>
         </Declarations>
         <Code Language="CSharp">
           <![CDATA[if ($parameter$ == null)
   {
       throw new ArgumentNullException("$parameter$");
   }
   $end$]]>
         </Code>
       </Snippet>
     </CodeSnippet>
   </CodeSnippets>

   ---

2. 作成した argnull.snippet を
   「C:\Users\(ユーザー名)\Documents\Visual Studio 2010\Code Snippets\Visual C#\My Code Snippets」フォルダー
   (Windows 7 の場合) に配置する。

手順は以上です。次回 Visual Studio を起動したときに利用可能になります。
[ツール] – [コード スニペット マネージャー] を開くと、「My Code Snippets」の中に現れるはずです。

コード スニペットを利用するときは、
C# のコード内で「argnull」と入力して Tab キーを 2 回入力します。
するとコード ブロックが自動的に挿入されるので、続けて引数の名前を入力すれば完了です。

バージョン情報
Visual Studio 2010

参照
IntelliSense コード スニペットの作成と使用 (MSDN ライブラリ)

広告