從 UML 類別圖表產生程式碼

若要在 Visual Studio Ultimate 中透過 UML 類別圖表產生 Visual C# .NET 程式碼，請使用 [產生程式碼] 命令。根據預設，命令會針對您選取的每個 UML 類型產生 C# 類型。 您可以修改或複製產生程式碼的文字範本來修改及擴充此行為。 您可以針對模型內的不同封裝中所包含的類型來指定不同的行為。

[產生程式碼] 命令特別適合從使用者選取的項目產生程式碼以及針對每一個 UML 類別或其他項目各產生一個檔案。 例如，此螢幕擷取畫面顯示從兩個 UML 類別產生的兩個 C# 檔案。

如果您想要產生的程式碼在產生的檔案與 UML 項目之間沒有 1:1 關聯性，您可以考慮撰寫以 [轉換所有範本] 命令叫用的文字範本當做替代方案。 如需該方法的詳細資訊，請參閱 如何：從 UML 模型產生檔案。

如需 Visual Studio Ultimate 中 UML 類別圖的詳細資訊，請參閱下列主題：

• UML 類別圖表：參考

• UML 類別圖表：方針

使用產生程式碼命令

下列程序將說明 [產生程式碼] 命令的預設行為：

若要針對每一個項目產生個別的檔案

1. 建立包含類別的 UML 模型。 您可能會想要將造型套用至模型項目。

   如需詳細資訊，請參閱預設程式碼產生轉換。

2. 在類別圖或 [UML 模型總管] 中，選取您想要產生程式碼的來源項目。 您可以選取下列其中一項：

   • 一組特定的項目。

   • 封裝或模型，可從其內容中產生程式碼。

   • 圖表，可選取圖表上的所有項目。

3. 開啟一個選取項目的捷徑功能表，然後選取 [產生程式碼]。

   當您第一次在特定模型中使用 [產生程式碼] 時，便會出現對話方塊。 此對話方塊可讓您編輯此模型的程式碼產生參數。

   除非您知道您想要改變這些參數，否則請選擇 [確定]。

   若要稍後返回對話方塊，開啟圖表的捷徑功能表然後選取 [設定預設程式碼產生設定]。 如需詳細資訊，請參閱自訂產生程式碼命令。

隨即產生包含 C# 程式碼的檔案。 在預設案例中，將會針對每一個類型產生檔案，而且會在 C# 類別庫專案中產生檔案。 然而，您可以自訂此行為。 如需詳細資訊，請參閱自訂產生程式碼命令。

某些驗證測試會套用到模型中，以確保它可以轉譯為 C#。 如果這些測試失敗，便會顯示錯誤訊息，而且不會執行程式碼產生作業。 如果您已經建立驗證功能表命令，則不會針對驗證命令失敗的任何項目產生程式碼。 如需詳細資訊，請參閱如何：定義 UML 模型的驗證條件約束。

預設程式碼產生轉換

本節摘要列出 [產生程式碼] 命令產生的結果 (除非您自訂此命令)。 如需詳細資訊，請參閱自訂產生程式碼命令。

• 將會針對您在 UML 模型中選取的每一個類型各產生一個 C# 類型。 每一個類型都會置於 GeneratedCode 資料夾底下的個別程式碼檔內。

• 如果 UML 類型包含在封裝內，則產生的 C# 類型會置於命名空間內，而且會在與此命名空間同名的資料夾中產生檔案。

• 針對 UML 類別的每一個 Attribute 產生 C# 屬性。

• 針對 UML 類型的每一個 Operation 產生 C# 方法。

• 針對此類別參與的每一個可巡覽的關聯產生 C# 欄位。

您可以藉由將造型加入至每一個 UML 類型來控制產生之 C# 類型的更多屬性。

若要在類型或其他項目上設定造型

1. 開啟圖表上項目的捷徑功能表或在 [UML 模型總管]選取 [內容]。

2. 在 [屬性] 視窗中，選擇 [造型] 屬性中的下拉箭號，然後針對您想要套用的造型選取核取方塊。

   提示

   如果 C# 造型並未出現，請針對此模型或是包含您有興趣之模型項目的封裝來啟用 C# 設定檔。在 [UML 模型總管] 中選取封裝或是此模型的根。然後在 [屬性] 視窗中，選擇 [設定檔]，然後啟用 C# 設定檔。

3. 展開 [造型] 屬性，查看您可以設定的其他屬性。

類型、屬性 (Attribute)、作業和關聯的 [描述] 屬性 (Property) 會在產生的程式碼中寫入 <summary> 註解。 連結至類型的註解項目會寫入 <remarks> 註解。

各種產生的程式碼

產生的程式碼會因為每一個類型、屬性或作業的屬性而異。 例如，如果您將類別的 [Is Abstract] 屬性設定為 true，則 abstract 關鍵字會出現在產生的類別上。 如果您將屬性 (Attribute) 的 [Multiplicity] 設定為 [0..*]，則產生的屬性 (Property) 將會擁有 IEnumerable<> 類型。

此外，每個造型都會提供您可以設定的幾個額外屬性。 這些值會解譯成 C# 程式碼中適當的關鍵字。 例如，如果您在類別上設定 Is Static 屬性，則 C# 類別將會是 static。

若要設定這些額外的屬性，請選取此類別或圖表中的其他項目。 在 [屬性] 視窗中展開 [造型]，然後展開 C# 造型，例如 [C# 類別]。 對於類別而言，這些額外的屬性包括：

• CLR 屬性

• Is Partial

• Is Static

• Is Unsafe

• 封裝可視性

每一個屬性 (Attribute) 和作業也會擁有您可以設定的造型屬性 (Property)。 如果您在新的屬性 (Attribute) 上看不到這些屬性 (Property)，請執行 [產生程式碼]。

自訂產生程式碼命令

[產生程式碼] 命令的運作方式是利用一組文字範本來轉換您的模型項目。 如需文字範本的詳細資訊，請參閱程式碼產生和 T4 文字範本。

這些範本會在一組「文字範本繫結」(Text Template Bindings) 中指定。 文字範本繫結會指定應該套用哪一個範本、應該將產生的輸出放在哪裡，以及 [產生程式碼] 命令的其他參數。

當您初次在特定模型上執行 [產生程式碼] 命令時，它會將一組預設的範本繫結附加至模型的根。 這些繫結會套用至模型內的所有項目。

但是，您可以覆寫及加入至這些預設繫結，方法是將您自己的繫結附加至封裝、類別或其他項目。 繫結會套用至附加它的項目內所包含的所有項目。 例如，如果您希望特定封裝內的所有類型都由一組不同的範本來轉換或者輸出到不同的資料夾，您可以將範本繫結附加至此封裝。

若要檢查附加至模型項目的範本繫結，請在 [屬性] 視窗中選擇 [文字範本繫結] 屬性內的省略符號 [...]。

[產生程式碼] 命令會將範本套用至您所選取的每一個模型項目。 對於每一個項目而言，套用的範本集合為附加至其容器的合併範本集合，一直到模型的根 (包含在內)。

如果此集合中的兩個範本繫結有相同的名稱，則較小容器內的繫結會覆寫較大容器內的繫結。 例如，模型根擁有名稱為 Class Template 的繫結。 若要將您自己的範本套用到特定封裝的內容，請定義擁有 Class Template 名稱的範本繫結。

可以將一個以上的範本套用至模型項目。 您可以從每一個模型項目產生一個以上的檔案。

注意事項
附加至模型根的繫結會當做模型內所有項目的預設值。若要查看這些預設繫結，開啟圖表介面上的捷徑功能表，然後選取 [設定預設程式碼產生設定]。或者，您也可以在 [UML 模型總管] 中選取模型的根，然後在 [Text Template Bindings] (文字範本繫結) 屬性中選擇 […]。除非您曾經使用過 [產生程式碼] 命令至少一次，否則繫結不會出現。範本繫結無法附加至圖表。

若要將文字範本繫結附加至封裝或其他模型項目

1. 在 [UML 模型總管]，開啟模型項目的捷徑功能表然後選取 [屬性]。 一般來說，您會將文字範本繫結附加至封裝或模型的根。

2. 在 [屬性] 視窗中，選取 [文字範本繫結] 屬性中的省略符號按鈕 ([…])。

   [Text Template Bindings] (文字範本繫結) 對話方塊隨即出現。

3. 選擇 [加入] 建立新的文字範本繫結。

   -或-

   選取現有的繫結加以編輯。

   每一個範本繫結都會定義應該如何將指定的範本套用到您所選取的模型項目，以及它所包含的其他模型項目。

4. 在此對話方塊中，設定文字範本繫結的屬性。

   屬性	描述
   名稱	這個繫結的名稱。 若要覆寫從包含的封裝或模型繼承的繫結，請使用與您想要覆寫的繫結相同的名稱。
   覆寫	若為 true，則會覆寫任何現有的程式碼。
   目標名稱	產生的檔案名稱。 您可以將運算式插入這個字串中，例如 {Name} 或 {Owner.Name}。 例如，您可以撰寫：{Owner.Name}_{Name}。 在模型項目上評估此運算式。 它可以使用項目的屬性，但不能使用方法。 若要尋找可以使用哪些屬性，請在 Microsoft.VisualStudio.Uml.* 中尋找類型的屬性。 重要 {Name} 或 {Owner.Name} 只能在 [目標名稱] 屬性中使用。若要變更產生之類別的名稱，您必須修改此範本。如需詳細資訊，請參閱撰寫文字範本。
   專案路徑	指定將包含轉換輸出檔案的 Visual Studio 專案路徑。 使用具類型的值來建立新的專案。 選取省略符號 ([…]) 來選取現有的專案。 將會建立新的專案 (如果不存在)。 這會是 C# 類別庫專案。 若要這麼做，您必須直接輸入專案。 您可以包含環境變數巨集，例如 %ProgramFiles% or %LocalAppData%。
   目標目錄	產生目標檔案的資料夾。 此路徑相對於專案資料夾。 您可以使用 {PackageStructure} 運算式插入路徑，此路徑會對應到包含的封裝名稱。 預設值是 \GeneratedCode\{PackageStructure}。 您也可以包含環境變數，例如 %TEMP% 或 %HomePath%。 > [!IMPORTANT] > <P>{PackageStructure} 只能在 [<STRONG>目標目錄</STRONG>] 屬性中使用。</P>
   範本檔路徑。	將要執行轉換的範本。 您可以使用提供的範本，或建立自己的範本。 您可以在下列位置找到提供的範本： …\Program Files\Microsoft Visual Studio 12.0\Common7\IDE\Extensions\Microsoft\Architecture Tools\Extensibility\Templates\Text\

   5. 您可以將不限數目的繫結附加至項目中。

   撰寫文字範本

   您可以撰寫自己的文字範本。 文字範本可以產生程式碼或任何其他種類的文字檔。

   我們建議您一開始先修改標準範本的複本。 您可以從下列位置複製範本：

   …\Program Files\Microsoft Visual Studio 12.0\Common7\IDE\Extensions\Microsoft\Architecture Tools\Extensibility\Templates\Text\

   若要了解文字範本，請參考下列主題。

   • 文字範本是結果檔案的原型，而且包含了結果文字以及讀取模型的程式碼。 如需詳細資訊，請參閱程式碼產生和 T4 文字範本。

   • 若要巡覽程式碼中的 UML 模型，您必須使用 UML API。 如需詳細資訊，請參閱如何：巡覽 UML 模型與UML 模型擴充性的 API 參考。

   若要搭配 [產生程式碼] 命令使用範本，您必須包含 Modeling 指示詞。 例如：

   <#@ Modeling ElementType="Microsoft.VisualStudio.Uml.Classes.IClass" Processor="ModelingProcessor" #>

   ElementType 屬性會定義套用這個範本之 UML 項目的類型。

   在此範本中，this 屬於具有下列屬性的暫時類別：

   • Element = 套用此範本的 UML IElement。

   • Errors: CompilerErrorCollection

   • Host: ITextTemplatingEngineHost

   • ModelBus: ModelBus. 如需詳細資訊，請參閱如何：整合 UML 模型與其他模型和工具。

   • ProfileName = "C#Profile"。

   • ServiceProvider: IServiceProvider

   • Session: TextTemplatingSession.

   • Store: Store. 這是 UML ModelStore 實作所在的 Visualization and Modeling SDK 存放區。 若要取得 UML IModelStore，請使用 this.Element.GetModelStore()。

   當您撰寫文字範本時，可能會發現以下要點非常實用。 此資訊在程式碼產生和 T4 文字範本中有詳細說明。

   • 您可以在 Output 指示詞中設定結果的副檔名。 每一個文字範本中都需要一個 Output 指示詞。

   • 此範本會自動參考某些組件。 例如，這些組件包括 System.dll 和 Microsoft.VisualStudio.Uml.Interfaces.dll。

     若要在您產生的程式碼中使用其他組件，您必須使用 Assembly 指示詞。 例如：

     <#@ Assembly Name="%ProgramFiles%\Microsoft Visual Studio 12.0\Common7\IDE\PublicAssemblies\Microsoft.VisualStudio.ArchitectureTools.Extensibility.dll" #>

   • 某些命名空間 (例如 System) 會自動匯入您的程式碼內。 對於其他命名空間，您可以依照使用 using 陳述式的相同方式來使用 Import 指示詞。 例如：

     <#@ Import Namespace="Microsoft.VisualStudio.Uml.Classes" #>

     <#@ Import Namespace="Microsoft.VisualStudio.ArchitectureTools.Extensibility.Uml" #>

   • 使用 Include 指示詞可參考另一個檔案的文字。

   • 以括號括住的範本部分 <# ... #> 是由 [產生程式碼] 命令所執行。 這些括號外面的範本部分會複製到結果檔案。 請務必區分產生程式碼與產生的文字。 產生的文字可以使用任何語言。

   • <#= Expressions #> 會評估及轉換為字串。

   請參閱

   概念

   UML 類別圖表：參考

   UML 類別圖表：方針

   如何：從 UML 模型產生檔案