VB.NET覚書

VB.NETの覚書
[個人メモ] [仕事メモ] [アイデア] [Ruby]
[TIPS] [対応表] [コメント書き方] [.NET Tips] [VB中学校] [VB.NET の入門サイト] [VB.NET コーディング標準 ] [VBレスキュー] [NonSoft]

2013-11-27

XML コメントを使用したコードドキュメント

より良いドキュメントの生成

Visual Basic コンパイラによって生成された XML は判読できるものの、使い勝手が優れているわけではありません。移動性に優れた、見栄えの良いドキュメント作成するために、さまざまなツールが作成されています

まずは、マイクロソフトによって開発された、"Sandcastle" と呼ばれるツールを紹介します。Sandcastleインストールしたら、ドキュメント化するアセンブリ、その依存関係、および XML ドキュメント ファイル収集します。それらをすべて Sandcastleインストール フォルダ (通常、C:\Program Files\Sandcastle\Examples\sandcastle) にコピーします。

昇格したコマンド プロンプトを開き、同じディレクトリに移動して、次のコマンドを実行します。

build_Sandcastle.bat prototype <your assembly name without the file extension>



この操作によって、ディレクトリファイルが生成されます

XML コメントを使用したコードのドキュメント化
トラックバック - http://sub.g.hatena.ne.jp/garyo/20131127