UML モデル中の .Net 要素での XML コメントの追加

プロパティー・ビューのうち、「ドキュメンテーション」ページと「XML コメント」ページの 2 つの位置に、XML コメントを追加できます。
始める前に

UML から C# への変換または .NET WCF プロファイルのいずれかをモデルに適用する必要があります。

「設定」ウィンドウで「モデリング」 > 「その他」を展開し、「ダイアグラムおよび文書でリッチ・テキストを表示」チェック・ボックスのチェックが外されていることを確認します。

このタスクについて
UML から C# への変換を実行すると、モデル中の XML コメントが XML タグとしてソース・コード中に生成され、またそれらが参照するコード・ブロックの直前の位置の特殊コメント・フィールドのテキストとして生成されます。 C# から UML への変換を実行すると、ソース・コード中の XML タグが、プロパティー・ビューの「ドキュメンテーション」ページおよび「XML コメント」ページでのコメントとして生成されます。
注: コード・ソース・ファイルの中で、プリプロセッサー・ディレクティブの前に XML コメントが出現する場合、モデル中に XML コメントは生成されません。 それらの領域はユーザー・コード・セクションと解釈されるからです。

「XML コメント」ページを使用して XML コメントを .NET 要素に追加するには、

  1. XML コメントをサポートする .NET 要素を含むモデルを作成します。
  2. モデルで、.NET 要素を選択します。
  3. カーソルを「XML コメント」ページ・エディターに移動します。 そこでボタンをクリックして、対応する XML タグの開始タグと終了タグを追加します。 XML タグに関連する属性も作成されます。
次のタスク

C# の場合は、ソース・コードの中で、XML タグの参照先コード・ブロックの直前の特殊コメント・フィールドに XML タグを含めることにより、コードのドキュメンテーションを作成することができます。

XML コメントを含むコードを /doc オプション付きでコンパイルすると、コンパイラーはすべての XML タグをソース・コードの中から検索し、XML ドキュメンテーション・ファイルを作成します。 コンパイラーが生成したファイルに基づいて最終ドキュメンテーションを作成するには、カスタム・ツールを作成することができます。


フィードバック