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

Question

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

有一些关于使用宏来执行此操作的教程，但显然 VS2012 不再支持宏。

我可以将 header 定义为代码片段并插入该片段，但片段不支持获取当前日期。

我可以使用以下 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 或快捷键？

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

Answer 1

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

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

• 将其设置为构建一个片段，然后构建您要插入的代码。对于我的问题中的示例，您要使用 T4 模板生成的代码段 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 处理将今天的日期注入(inject)到代码段 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 的代码，它手动读取输出文件并将其写入片段文件。棘手的部分是我们必须指定绝对路径。完整的 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 模板两次 - 第一次运行生成片段代码，第二次运行将前一次运行的输出写入片段文件夹。为此，请右键单击解决方案资源管理器中的模板，然后单击 Run Custom Tool .

• 现在您可以右键单击代码中的任意位置，选择 Insert Snippet...并从 My Code Snippets 中选择生成的片段团体。结果:

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

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