插入 T4 生成的代码，就好像它是一个片段一样

Question

我正在寻找一种方法来快速、定期地将我的签名和日期添加到 Visual Studio 中新代码文件的顶部。

有一些关于使用宏来做到这一点的教程，但显然 VS2012 不再支持宏。

我可以将header定义为代码sn-p并插入sn-p，但是sn-ps不支持获取当前日期。

我可以使用以下 T4 模板生成正确的文本：

<#@ template debug="false" hostspecific="false" language="C#" #>

// <author>Pieter Müller</author>
// <date><#=DateTime.Now.ToString("yyyy-MM-dd")#></date>

<#@ output extension=".cs" #>

这给了我以下完美的结果：

// <author>Pieter Müller</author>
// <date>2012-10-30</date>

问题是，有没有办法让我快速、定期地将这段代码插入到新的代码文件中，无论是自动还是手动使用类似于Insert Snippet 的东西或快捷键？ p>

如果您没有答案，但您对生成我需要的签名标头确实有一个好主意，请发表评论。谢谢！

Answer 1

我不想回答我自己的问题，但我确实想出了一种将 T4 模板作为 sn-ps 的方法，尽管它的 Hack Level 超过 9000。它通过编写一个生成 sn-p 的 T4 模板来工作，然后它会自动将其复制到 Visual Studio sn-p 文件夹。

• 将Text Template 项添加到您的项目中。

• 设置它以构建一个 sn-p，然后构建您要插入的代码。对于我的问题中的示例，您要使用 T4 模板生成的 sn-p XML 如下所示：

  <?xml version="1.0" encoding="utf-8"?>
  <CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
      <Header>
        <SnippetTypes>
          <SnippetType>Expansion</SnippetType>
        </SnippetTypes>
        <Title>DateHeaderSnippet</Title>
        <Author>user</Author>
      </Header>
      <Snippet>
        <Code Language="csharp">
          <![CDATA[//    <author>Pieter Muller</author>
  //    <date>{Today's Date}</date>]]>
        </Code>
      </Snippet>
    </CodeSnippet>
  </CodeSnippets>
  

  • 要使用 T4 模板生成上述 XML，我们可以几乎逐字插入 XML，有两个更改。首先，这一行：

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

    必须在手动 WriteLine 语句中，否则<?xml 标签会混淆 T4 模板处理器：

    <# WriteLine("<?xml version=\"1.0\" encoding=\"utf-8\"?>"); #>
    

  • 其次，我们想使用T4处理将今天的日期注入到sn-p XML中，所以我们改变：

            <![CDATA[//    <author>Pieter Muller</author>
    //    <date>{Today's Date}</date>]]>
    

    到：

            <![CDATA[//    <author>Pieter Muller2</author>
    //    <date><#=DateTime.Now.ToString("yyyy-MM-dd")#></date>]]>
    

• 我们还在 T4 模板的末尾添加了一些非常 hacky 的代码，手动读取输出文件并将其写入 sn-p 文件。最棘手的部分是我们必须指定绝对路径。完整的 T4 代码如下所示：

  <#@ template debug="false" hostspecific="false" language="C#" #>
  <#@ output extension=".txt" #>
  <# WriteLine("<?xml version=\"1.0\" encoding=\"utf-8\"?>"); #>
  <CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
      <Header>
        <SnippetTypes>
          <SnippetType>Expansion</SnippetType>
        </SnippetTypes>
        <Title>DateHeaderSnippet</Title>
        <Author>user</Author>
      </Header>
      <Snippet>
        <Code Language="csharp">
          <![CDATA[//    <author>Pieter Muller2</author>
  //    <date><#=DateTime.Now.ToString("yyyy-MM-dd")#></date>]]>
        </Code>
      </Snippet>
    </CodeSnippet>
  </CodeSnippets>
  <#    
      System.IO.StreamReader sr = new System.IO.StreamReader(@"C:\Users\Pieter\Documents\Visual Studio 2010\Projects\tmp\tmp\TextTemplateToWriteHeaderTemplate.txt");
      string sourceText = sr.ReadToEnd();
      sr.Close();
  
      System.IO.StreamWriter sw = new System.IO.StreamWriter(@"C:\Users\Pieter\Documents\Visual Studio 2010\Code Snippets\Visual C#\My Code Snippets\tryout.snippet");    
      sw.WriteLine(sourceText);    
      sw.Close();    
  #>
  

• 您必须编译 T4 模板两次 - 第一次运行生成 sn-p 代码，第二次运行将前一次运行的输出写入 sn-p 文件夹。为此，请右键单击解决方案资源管理器中的模板，然后单击 Run Custom Tool。

• 现在您可以右键单击代码中的任意位置，选择Insert Snippet... 并从My Code Snippets 组中选择生成的sn-p。结果：

  //    <author>Pieter Muller2</author>
  //    <date>2012-11-09</date>
  

我知道这方式只是插入一个简单的作者和日期标题太麻烦了，但希望其他人可以使用这种技术来做一些更宏大的事情。您几乎可以通过这种方式生成任何类型的动态 sn-p。

Answer 2

希望您使用的是ReSharper，它具有强大的模板。我已经使用非常简单的模板变量配置实现了您的示例

现在，如果我输入“hd”并按 Tab 这个宏，我将收到下一个结果：