使用CodeSmith加快开发进度
【IT168 技术文档】
随着开发进度表的缩短,开发者不可能使用太多的时间。代码生成工具可生成常见的通用代码,为你节省宝贵的时间。让我们通过CodeSmith工具来了解一下这种开发趋势吧!
设计式样为常见的编程问题提供了标准解决方法。但是,开发人员发现自己总是要不断地输入同样的代码。代码生成工具提供了起步所必须的基础代码,从而解决这一问题。它加快了开发过程,并保证了代码的稳定性与可靠性。让我们通过CodeSmith来详细了解一下代码生成过程。
1 CodeSmith介绍
CodeSmith是一个基于模板的代码生成器。模板是所生成代码的式样。开发者或构架师可应用CodeSmith来生成任何文本语言的代码。其结果(生成的代码)可通过属性来自定义并包含在众多的标准属性类型之中。另外,用户还可建立自定义的属性类型。
针对.NET Framework而言,性质可以是任何拥有设计器的.NET对象。例如,它可以是一个简单的分配标题的字符串性质。另一方面,可用TableSchema对象来访问数据库表中的一切内容。
CodeSmith工具的一个强项是它的语法,其与ASP.NET的方法相当。实际上,你可以在CodeSmith模板中应用C#、VB.NET或Jscript。事实上,CodeSmith可输入任何ASCII语言。
CodeSmith 包括两个工具,一个是CCodeSmithStudio.exe是用来设计和编译模板;另一个是CodeSmith.exe是用来运行模板生成代码的, CodeSmith.exe还可以与VS.NET集成,成为VS.NET的一个外部工具。
2 CodeSmith入门
创建好一个模板后,第一步要指明这是一个C#语言的模板。
<%@ CodeTemplate Language="C#" TargetLanguage="C#"
Description="Generates a class including a special informational header" %>
第二步,我们要指明模板在生成代码时的属性,即生成代码需要的输入值变量。
<%@ Property Name="NameSpace" Type="String" Category="Context" Description="The namespace to use for this class" %>
如上所示,在进行代码生成时,在CodeSmith Explorer中选择模板后生成代码的窗口中,变量的名称为NameSpace,类型是String,类别是Context,当用户选中这个属性时对于属性的描述Description。
我们可以按照C#语言的语法去使用定义的变量,例如:
/**////////////////////////////////////////////////////////////////////////////////////////
// File: <%=ClassName%>.cs
例如,下面这个例子模板使用了上面介绍的知识。
<%@ CodeTemplate Language="C#" TargetLanguage="C#"
Description="Generates a class including a special informational header" %>
<%@ Property Name="NameSpace" Type="String" Category="Context"
Description="The namespace to use for this class" %>
<%@ Property Name="ClassName" Type="String"
Category="Context"
Description="The name of the class to generate" %>
<%@ Property Name="DevelopersName" Type="String"
Category="Context"
Description="The name to include in the comment header" %>
/**////////////////////////////////////////////////////////////////////////////////////////
![]()
// File: <%=ClassName%>.cs
// Description: Enter summary here after generation.
// ---------------------
// Copyright ?<%= DateTime.Now.Year %> Our Client
// ---------------------
// History
// <%= DateTime.Now.ToShortDateString() %> <%= DevelopersName%> Original Version
/**////////////////////////////////////////////////////////////////////////////////////////
![]()
using System;
![]()
namespace <%=NameSpace %>
...{
/**//// <summary>
/// Summary description for <%=ClassName %>.
/// </summary>
public class <%=ClassName %>
...{
public <%=ClassName %>()
...{
//
// TODO: Add constructor logic here
//
}
}
}
