代码片段：从创建到安装的逐步指南

D. 代码片段函数

Visual C# 代码片段有三个可用的函数：

1. **GenerateSwitchCases(** EnumerationLiteral **)**

   为 EnumerationLiteral 参数指定的枚举成员生成一个 switch 语句和一组 case 语句。EnumerationLiteral 参数必须是对枚举成员或枚举类型的引用。

   例如

   <?xml version="1.0" encoding="utf-8"?> 
   
   <CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet"> 
   
     <CodeSnippet Format="1.0.0"> 
   
       <Header> 
   
         <Title>myswitch</Title> 
   
         <Shortcut>myswitch</Shortcut> 
   
         <Description>Code snippet for switch statement</Description> 
   
         <Author>Microsoft Corporation</Author> 
   
         <SnippetTypes> 
   
           <SnippetType>Expansion</SnippetType> 
   
         </SnippetTypes> 
   
       </Header> 
   
       <Snippet> 
   
         <Declarations> 
   
           <Literal> 
   
             <ID>expression</ID> 
   
             <ToolTip>Expression to switch on</ToolTip> 
   
             <Default>switch_on</Default> 
   
           </Literal> 
   
           <Literal Editable="false"> 
   
             <ID>cases</ID> 
   
             <Function>GenerateSwitchCases($expression$)</Function> 
   
             <Default>default:</Default> 
   
           </Literal> 
   
         </Declarations> 
   
         <Code Language="csharp"> 
   
           <![CDATA[ 
   
                       switch ($expression$) 
   
                       { 
   
                          $cases$ 
   
                       } 
   
                   ]]> 
   
         </Code> 
   
       </Snippet> 
   
     </CodeSnippet> 
   
   </CodeSnippets>

   使用示例：

   

   一目了然：VS 编辑器快照 – 选择片段

   

   将 **swich_on**（高亮显示为绿色）替换为我们的 **enum**，然后按两次 Enter 键。

   

   一目了然：VS 编辑器快照 – 使用片段的最终结果

2. ClassName()

   返回包含插入片段的类的名称。

   例如，要为带输入参数的类编写构造函数：

   <?xml version="1.0" encoding="utf-8"?> 
   
   <CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet"> 
   
     <CodeSnippet Format="1.0.0"> 
   
       <Header> 
   
         <Title>Common constructor pattern</Title> 
   
         <Shortcut>myconstructor</Shortcut> 
   
         <Description>Code Snippet for a constructor</Description> 
   
         <Author>Anand Ranjan Pandey</Author> 
   
         <SnippetTypes> 
   
           <SnippetType>Expansion</SnippetType> 
   
         </SnippetTypes> 
   
       </Header> 
   
       <Snippet> 
   
         <Declarations> 
   
           <Literal> 
   
             <ID>type</ID> 
   
             <Default>int</Default> 
   
           </Literal> 
   
           <Literal> 
   
             <ID>name</ID> 
   
             <Default>field</Default> 
   
           </Literal> 
   
           <Literal Editable="false"> 
   
             <ID>classname</ID> 
   
             <ToolTip>Class name</ToolTip> 
   
             <Function>ClassName()</Function> 
   
             <Default>ClassNamePlaceholder</Default> 
   
           </Literal> 
   
         </Declarations> 
   
         <Code Language="CSharp" Kind="CData"> 
   
           <![CDATA[ 
   
                       public $classname$ ($type$ $name$) 
   
                       { 
   
                           this._$name$ = $name$; 
   
                       } 
   
                       private $type$ _$name$; 
   
                   ]]> 
   
         </Code> 
   
       </Snippet> 
   
     </CodeSnippet> 
   
   </CodeSnippets>

   用法示例

   

   

   一目了然：VS 编辑器快照 – 使用片段的最终结果

3. **SimpleTypeName(** TypeName **)**

   它将 TypeName 参数简化为其在调用片段的上下文中的最简单形式。

   例如：下面的示例展示了如何使用 SimpleTypeName 函数。当此片段插入到代码文件中时，$SystemConsole$ 字面量将被替换为在调用片段的上下文中 Console 类型的最简单形式。

   <?xml version="1.0" encoding="utf-8"?> 
   
   <CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet"> 
   
     <CodeSnippet Format="1.0.0"> 
   
       <Header> 
   
         <Title>Console_WriteLine</Title> 
   
         <Shortcut>mycw</Shortcut> 
   
         <Description>Code snippet for Console.WriteLine</Description> 
   
         <Author>Anand Ranjan Pandey</Author> 
   
         <SnippetTypes> 
   
           <SnippetType>Expansion</SnippetType> 
   
         </SnippetTypes> 
   
       </Header> 
   
       <Snippet> 
   
         <Declarations> 
   
           <Literal Editable="false"> 
   
             <ID>SystemConsole</ID> 
   
             <Function>SimpleTypeName(global::System.Console)</Function> 
   
           </Literal> 
   
         </Declarations> 
   
         <Code Language="csharp"> 
   
           <![CDATA[ 
   
                       $SystemConsole$.WriteLine(); 
   
                   ]]> 
   
         </Code> 
   
       </Snippet> 
   
     </CodeSnippet> 
   
   </CodeSnippets>

   用法示例

   

   

   一目了然：VS 编辑器快照 – 使用片段的最终结果

E. 是否可以与我的所有团队成员共享？？

是的，要使代码片段出现在代码编辑器中，它必须位于用户的计算机上并通过 **代码片段管理器** 导入。为了简化此过程，我们可以将片段文件放在 **Visual Studio 安装程序 (.vsi)** 文件中，并使用 Visual Studio 内容安装程序将文件放置在正确的位置。然后，可以轻松地将 **.vsi 文件** 与社区中的其他开发人员共享。

.vsi 文件创建步骤

Visual Studio 内容安装程序 (.vsi) 文件用于在开发者社区中交换 Visual Studio 内容。.vsi 文件是一个重命名的 .zip 文件，其中包含以下组件：

• 描述内容的 XML .vscontent 文件。
• 内容文件。

步骤 1： 文件 - 新建 - 文件

步骤 2： 从模板中选择 **XML** 文件类型

步骤 3： 按照给定架构，在 <FileName> 标签内添加文件/文件。有关架构信息，请参阅 Visual Studio 内容安装程序架构参考

在我的情况下，.vscontent 文件包含了以上所有示例。

<?xml version="1.0" encoding="utf-8"?> 

<VSContent xmlns="http://schemas.microsoft.com/developer/vscontent/2005"> 

  <Content> 

    <FileName>getCustomer.snippet</FileName> 

    <FileName>myconstructor.snippet</FileName> 

    <FileName>mycw.snippet</FileName> 

    <FileName>myswitch.snippet</FileName> 

    <FileName>propcs.snippet</FileName> 

    <FileName>singletonts.snippet</FileName> 

    <FileName>singletontswl.snippet</FileName> 

    <DisplayName>Sample Code Snippet</DisplayName> 

    <Description>A code snippet created for this example</Description> 

    <FileContentType>My Code Snippet</FileContentType> 

    <ContentVersion>1.0</ContentVersion> 

    <Attributes> 

      <Attribute name="language" value="csharp"/> 

    </Attributes> 

  </Content> 

</VSContent>

步骤 4： 将文件保存为 **.vscontent** 扩展名，例如 MyCodeSnippet.vscontent

步骤 5：将 .vscontent 文件保存在与社区组件相关的其他文件相同的目录中。

步骤 6：选择文件夹，右键单击，选择 **发送到**，然后单击 **压缩(zipped)文件夹**。选定的文件将被压缩成一个 .zip 文件。

步骤 7：重命名 **.zip** 文件的扩展名为 **.vsi**

步骤 8：转到 C:\...\我的文档\Visual Studio <版本>\Addins\

步骤 9：将早期创建的 .vsi 文件粘贴到此文件夹中。我正在使用 Visual Studio 2008。

步骤 10：现在，您新创建的代码片段已准备好在 Visual Studio 2008 编辑器中使用。

F. 一个示例

让我们以单例类为例，它几乎用于每个项目。在本例中，我将创建一个代码片段，该代码片段将使用单例类概念生成代码。

单例示例 1

在此代码片段中，实现是线程安全的。线程锁定共享对象，然后检查实例是否已在创建实例之前创建。这解决了内存屏障问题（因为锁定确保所有读取都发生在锁定获取之后，而解锁确保所有写入都发生在锁定释放之前），并确保只有一个线程创建实例（因为同一时间只有一个线程可以进入该代码部分 - 当第二个线程进入时，第一个线程已经创建了实例，因此表达式将评估为 false）。不幸的是，性能会受到影响，因为每次请求实例时都会获取锁。

**文件名：** singletontswl.snippet

代码

<?xml version="1.0" encoding="utf-8"?> 

<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet"> 

  <CodeSnippet Format="1.0.0"> 

    <Header> 

      <Title>Thread safe Singleton Pattern with Lock</Title> 

      <Shortcut>singletontswl</Shortcut> 

      <Description>Code Snippet for a singleton class : Thread-safe with locks</Description> 

      <Author>Anand Ranjan Pandey</Author> 

      <SnippetTypes> 

        <SnippetType>Expansion</SnippetType> 

      </SnippetTypes> 

    </Header> 

    <Snippet> 

      <Declarations> 

        <Literal> 

          <ID>instancename</ID> 

          <Default>instance</Default> 

        </Literal> 

        <Literal> 

          <ID>instanceobject</ID> 

          <Default>Instance</Default> 

        </Literal> 

        <Literal> 

          <ID>lockobject</ID> 

          <Default>padlock</Default> 

        </Literal> 

        <Literal Editable="false"> 

          <ID>classname</ID> 

          <ToolTip>Class name</ToolTip> 

          <Function>ClassName()</Function> 

          <Default>ClassNamePlaceholder</Default> 

        </Literal> 

      </Declarations> 

      <Code Language="CSharp" Kind="CData"> 

        <![CDATA[ 

                    static $classname$ $instancename$ =null; 

                    static readonly object $lockobject$ = new object(); 

                    $classname$() 

                    { 

                    } 

 

                    public static $classname$ $instanceobject$ 

                    { 

                        get 

                        { 

                            lock ($lockobject$) 

                            { 

                                if ($instancename$==null) 

                                { 

                                    $instancename$ = new $classname$(); 

                                } 

                                return $instancename$; 

                            } 

                        } 

                    } 
        
                ]]> 

      </Code> 

    </Snippet> 

  </CodeSnippet> 

</CodeSnippets>

现在我们使用 **代码片段管理器** 注册此片段，并在我们的单例类中使用它，如下所示：

按 Tab 键后，最终结果是：

单例示例 2

在此代码片段中，实现是线程安全的，无需使用锁。

**文件名：** singletonts.snippet

代码

<?xml version="1.0" encoding="utf-8"?> 

<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet"> 

  <CodeSnippet Format="1.0.0"> 

    <Header> 

      <Title>Thread safe Singleton Pattern</Title> 

      <Shortcut>singletonts</Shortcut> 

      <Description>Code Snippet for a singleton class : Thread-safe without using locks</Description> 

      <Author>Anand Ranjan Pandey</Author> 

      <SnippetTypes> 

        <SnippetType>Expansion</SnippetType> 

      </SnippetTypes> 

    </Header> 

    <Snippet> 

      <Declarations> 

        <Literal> 

          <ID>instancename</ID> 

          <Default>instance</Default> 

        </Literal> 

        <Literal> 

          <ID>instanceobject</ID> 

          <Default>Instance</Default> 

        </Literal> 

        <Literal Editable="false"> 

          <ID>classname</ID> 

          <ToolTip>Class name</ToolTip> 

          <Function>ClassName()</Function> 

          <Default>ClassNamePlaceholder</Default> 

        </Literal> 

      </Declarations> 

      <Code Language="CSharp" Kind="CData"> 

        <![CDATA[ 

                    static readonly $classname$ $instancename$=new $classname$(); 

                    // Explicit static constructor to tell C# compiler 

                    // not to mark type as beforefieldinit 

                    static $classname$() 

                    { 

                    } 

                    $classname$() 

                    { 

                    } 

 

                    public static $classname$ $instanceobject$ 

                    { 

                        get 

                        { 

                            return $instancename$; 

                        } 

                    } 

                ]]> 

      </Code> 

    </Snippet> 

  </CodeSnippet> 

</CodeSnippets>

现在我们使用 **代码片段管理器** 注册此片段，并在我们的单例类中使用它，如下所示：

按 Tab 键后，最终结果是：

代码片段就讲到这里。希望您会喜欢！

如何使用代码

注意：要使用示例，请按照以下步骤操作：

1. 将 MyCodeSnippets.zip 文件解压缩到您想要的任何目录。
2. 打开代码片段管理器，并添加 **MyCodeSnippets** 文件夹。

   

3. 现在代码片段已准备好使用。

注意：以上所有示例都包含在 MyCodeSnippets.zip 文件中。

参考

MSDN：http://msdn.microsoft.com/en-us/library/ms165392(VS.80).aspx

**欢迎提供评论/查询！！！**