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

时间:2012-10-30 14:27:10

标签: visual-studio t4 code-snippets

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

有一些使用宏来完成此操作的教程,但VS2012中不再支持宏。

我可以将标头定义为代码段并插入代码段,但代码段不支持获取当前日期。

我可以使用以下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类似的东西或快捷键?

如果您没有答案,但是您确实想要生成我需要的签名标题,请发表评论。谢谢!

2 个答案:

答案 0 :(得分:3)

我讨厌回答我自己的问题,但我确实找到了将T4模板作为片段的方法,虽然它的Hack级别超过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处理将今天的日期注入到片段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的代码,它们手动读取输出文件并将其写入代码段文件。这个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>
    

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

答案 1 :(得分:2)

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

现在,如果我输入'hd'并按Tab键此宏,我将收到下一个结果: enter image description here enter image description here