通过

演练：调试访问模型的文本模板

  • 项目

在域特定的语言解决方案中修改或添加文本模板时，当引擎将模板转换为源代码或编译生成的代码时，可能会出现错误。 下面的演练演示了调试文本模板时可以执行的一些操作。

注意

有关文本模板的详细信息，请参阅代码生成和 T4 文本模板。 有关调试文本模板的详细信息，请参阅演练：调试文本模板。

创建域特定语言解决方案

在此过程中，创建具有以下特征的域特定语言解决方案：

  • 名称：DebuggingTestLanguage

  • 解决方案模板：最小语言

  • 文件扩展名：.ddd

  • 公司名称：Fabrikam

    有关创建域特定语言解决方案的详细信息，请参阅如何：创建域特定语言解决方案。

创建文本模板

向解决方案添加文本模板。

创建文本模板

  1. 生成解决方案并开始在调试器中运行它。 （在“生成”菜单中，单击“重新生成解决方案”，然后在“调试”菜单上，单击“开始调试”。）Visual Studio 的新实例打开调试项目 。

  2. 向调试项目添加一个名为 DebugTest.tt 的文本文件。

  3. 确保将 DebugTest.tt 的“自定义工具”属性设置为 TextTemplatingFileGenerator。

从文本模板访问模型的调试指令

必须先调用生成的指令处理器，然后才能从文本模板中的语句和表达式访问模型。 调用生成的指令处理器会使模型中的类作为属性供文本模板代码使用。 有关详细信息，请参阅从文本模板中访问模型。

在以下过程中，将调试不正确的指令名称和不正确的属性名称。

调试不正确的指令名称

  1. 将 DebugTest.tt 中的代码替换为以下代码：

    注意

    代码包含错误。 你引入错误，以便对其进行调试。

    <#@ template language="C#" inherits="Microsoft.VisualStudio.TextTemplating.VSHost.ModelingTextTransformation"#>
<#@ output extension=".txt" #>
<#@ modelRoot processor="DebuggingTestLanguageDirectiveProcessor" requires="fileName='Sample.ddd'" provides="ExampleModel=ExampleModel" #>

Model: <#= this.ExampleModel #>
<#
foreach (ExampleElement element in this.ExampleModel.Elements)
{
#>
    Element: <#= element.Name #>
<#
}
#>

  2. 在“解决方案资源管理器”中，右键单击 DebugTest.tt，然后单击“运行自定义工具” 。

    “错误列表”窗口显示此错误：

    名为“DebuggingTestLanguageDirectiveProcessor”的处理器不支持名为“modelRoot”的指令。 将不会运行转换。

    在这种情况下，指令调用包含不正确的指令名称。 你已指定 modelRoot 作为指令名称，但正确的指令名称为 DebuggingTestLanguage。

  3. 双击“错误列表”窗口中的错误以跳转到代码。

  4. 若要更正代码，请将指令名称更改为 DebuggingTestLanguage。

    更改突出显示。

    <#@ DebuggingTestLanguage processor="DebuggingTestLanguageDirectiveProcessor" requires="fileName='Sample.ddd'" provides="ExampleModel=ExampleModel" #>

  5. 在“解决方案资源管理器”中，右键单击 DebugTest.tt，然后单击“运行自定义工具” 。

    现在，系统转换文本模板并生成相应的输出文件。 “错误列表”窗口将不会显示任何错误。

调试不正确的属性名称

  1. 将 DebugTest.tt 中的代码替换为以下代码：

    注意

    代码包含错误。 你引入错误，以便对其进行调试。

    <#@ template language="C#" inherits="Microsoft.VisualStudio.TextTemplating.VSHost.ModelingTextTransformation"#>
<#@ output extension=".txt" #>
<#@ DebuggingTestLanguage processor="DebuggingTestLanguageDirectiveProcessor" requires="fileName='Sample.ddd'" provides="ExampleModel=LibraryModel" #>

Model: <#= this.ExampleModel #>
<#
foreach (ExampleElement element in this.ExampleModel.Elements)
{
#>
    Element: <#= element.Name #>
<#
}
#>

  2. 在“解决方案资源管理器”中，右键单击 DebugTest.tt，然后单击“运行自定义工具” 。

    此时将显示“错误列表”窗口，并显示以下错误之一：

    (C#)

    编译转换：Microsoft.VisualStudio.TextTemplating<GUID>. GeneratedTextTransformation 不包含“ExampleModel”的定义

    (Visual Basic)

    编译转换：“ExampleModel”不是“Microsoft.VisualStudio.TextTemplating<GUID>.GeneratedTextTransformation”的成员。

    在这种情况下，文本模板代码包含不正确的属性名称。 你已指定 ExampleModel 作为属性名称，但正确的属性名称为 LibraryModel。 可以在提供的参数中找到正确的属性名称，如下列代码所示：

    <#@ DebuggingTestLanguage processor="DebuggingTestLanguageDirectiveProcessor" requires="fileName='Sample.ddd'" provides="ExampleModel=LibraryModel" #>

  3. 双击“错误列表”窗口中的错误以跳转到代码。

  4. 若要更正代码，请在文本模板代码中将属性名称更改为 LibraryModel。

    突出显示所作更改。

    <#@ template language="C#" inherits="Microsoft.VisualStudio.TextTemplating.VSHost.ModelingTextTransformation"#>
<#@ output extension=".txt" #>
<#@ DebuggingTestLanguage processor="DebuggingTestLanguageDirectiveProcessor" requires="fileName='Sample.ddd'" provides="ExampleModel=LibraryModel" #>

Model: <#= this.LibraryModel #>
<#
foreach (ExampleElement element in this.LibraryModel.Elements)
{
#>
    Element: <#= element.Name #>
<#
}
#>

  5. 在“解决方案资源管理器”中，右键单击 DebugTest.tt，然后单击“运行自定义工具” 。

    现在，系统转换文本模板并生成相应的输出文件。 “错误列表”窗口将不会显示任何错误。