本文翻譯的內容為CodeSmith控制臺指南。

很多人僅僅知道CodeSmith像一個圖形應用程序，或者可能是一個Visual Studio的附件，但是通過CodeSmith的控制臺應用程序還有好多其他的使用方法。控制臺應用程序是很有價值的，因為可以通過它去生成腳本，或者其他一些自動工具。這篇文檔的目的就是要告訴你怎樣使用它的控制臺應用程序并且如何去定義變量和參數。

Basic Usage

大多數情況下是用控制臺應用程序來創建一個模板，一個屬性文件，然后保存輸出的文件。這有一個很好的例子介紹將合并模版的處理過程放到一個過程中，就像使用NAnt工具。

首先我們要確定完成一個什么樣的模版，為這個模板創建一個什么樣的XML屬性文件。XML屬性文件提供在執行模版是需要的各個屬性。生成一個屬性文件最簡單的方法是在CodeSmith Explorer中打開一個模版，填寫屬性，點擊生成按鈕generate，然后再點擊Save Property Set XML按鈕。這個按鈕會在點擊完生成按鈕后找到，在Save Output和Copy Output按鈕旁邊。然后系統提示輸入保存XML屬性文件的文件名，下面看一個ArrayList.cst模版創建的XML屬性文件。

?1<?xml?version="1.0"?encoding="us-ascii"?>
?2<codeSmith>
?3????????????<propertySet>
?4????????????????????????<property?name="Accessibility">Public</property>
?5????????????????????????<property?name="ClassName">PersonArray</property>
?6????????????????????????<property?name="ItemType">Person</property>
?7????????????????????????<property?name="ItemValueType">False</property>
?8????????????????????????<property?name="ItemCustomSearch">False</property>
?9????????????????????????<property?name="KeyName">PersonID</property>
10????????????????????????<property?name="KeyType">int</property>
11????????????????????????<property?name="IncludeInterfaces">True</property>
12????????????????????????<property?name="IncludeNamespaces">False</property>
13????????????</propertySet>
14</codeSmith>

就像看到的一樣，也可以手動創建這個文件，但是使用

CodeSmith Explorer會更簡便。

現在我們有了這個XML文件，我們繼續看一下如何去執行這個模版并是用控制臺工具保存結果。首先我們需要是用/template參數去聲明我們要是用的模版，像這樣：

C:\Program Files\CodeSmith\v3.0>cs /template:Samples\Collections\ArrayList.cst

在這個例子中我們使用了ArrayList.cst模版，它存儲在本地的Samples\Collections文件夾下。下一步我們要去聲明我們在最后一步需要創建的XML文件，我們是用/propertyset參數去實現。

C:\Program Files\CodeSmith\v3.0>cs /template:Samples\Collections\ArrayList.cst? /propertyset:PersonArray.xml

這個/property參數用來指定我們的XML屬性文件。最后一個我們需要用的參數是/output參數，用來指定輸出怎樣被保存。

C:\Program Files\CodeSmith\v3.0>cs /template:Samples\Collections\ArrayList.cst /propertyset:PersonArray.xml /out:test.cs

使用/out參數指定將結果輸出到一個叫test.cs文件中保存。執行這個命令后，模板將開始運行，使用屬性文件將結果輸出到test.cs文件保存。

這是大多數情況下有效使用控制臺。

?

Merging Output

在各種代碼生成中最大的挑戰就是將生成的代碼和開發人員編寫或修改的代碼區分開。控制臺對這個問題提供了一個有效的獨特的解決方案，使用一個指定的參數在當前已存在的代碼文件中需要將模板生成的代碼添加的地方指定一塊區域。

下面是一個簡單的代碼文件，包含了我們要添加生成代碼的區域。

1using?System;
2
3namespace?Entities
4{
5??????GeneratedOrderEntity#region?GeneratedOrderEntity
6?
7
8??????#endregion??
9}

我們的目標是將DatabaseSchema\BusinessObject.cst模版生成的代碼添加到類文件的GeneratedOrderEntity區域中。和上一個例子一樣，使用CodeSmith console控制臺應用程序執行這個模版，但是這次要使用另一個參數merge。

C:\Program Files\CodeSmith\v3.0>cs /template:Samples\DatabaseSchema\BusinessObject.cst /propertyset:OrderEntity.xml /out:OrderEntity.cs /merge:InsertRegion= "RegionName=Sample Generated Region;Language=C#;"

使用merge參數我們可以指定區域的名稱，在這個例子中是GeneratedOrderEntity，然后控制臺應用程序將執行模版，并將結果添加到這個區域中。我們來看一下執行完這個指令后生成的代碼。

?1using?System;
?2
?3namespace?Infozerk.AuthServices.UnitTestSuite
?4{
?5??????GeneratedOrderEntity#region?GeneratedOrderEntity
?6??????
?7
?8??????Order#region?Order
?9??????/**////?<summary>
10??????///?This?object?represents?the?properties?and?methods?of?a?Order.
11??????///?</summary>
12??????public?class?Order
13??????{
14????????????protected?int?_id;
15????????????protected?string?_customerID?=?String.Empty;
16????????????protected?int?_employeeID;
17????????????protected?DateTime?_orderDate;
18????????????protected?DateTime?_requiredDate;
19????????????protected?DateTime?_shippedDate;
20????????????protected?int?_shipVia;
21
22--為了簡短省略了類的其他部分

就像看到的一樣，Order類被添加到了我們指定的區域中。在代碼文件中使用merge參數生成的內容在其他部分被修改或手寫后很容易重新再次生成而不會產生影響。

?

參數介紹Parameter Reference

?

Specifying Output

/out:<file>

指定從模版創建的輸出文件的名稱。

/out:default

指定這個文件被默認保存成模版是用的名稱。

/merge:<mergetype>=<init>

指定模版輸出的區域。可以簡寫為/m

?

Specifying Input

/template:<file>

選擇要執行的模版，簡寫為/t

/propertyset:<file>

生成代碼時需要使用的XML屬性文件。簡寫為/p

?

Compiler Options

/debug[+|-]

指定模版需要包含的調試信息。（允許在運行模版時進行調試）

/tempfiles[+|-]

指定保留臨時文件。（如果在臨時文件上調試也可以）

?

Miscellaneous

/help

顯示幫助信息。

/nologo

禁止生成器版權信息。

轉載于:https://www.cnblogs.com/wayne-ivan/archive/2007/06/15/784392.html

總結

以上是生活随笔為你收集整理的CodeSmith基础（七）的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。