C# ドキュメントコメントのCHMファイル(MSDNライクな形式)化

c#

以下、私的メモ。詳細については、参考URLまたは検索を使用すること。

XMLドキュメントコメント

C#にはドキュメントコメントというものがある。MSDNのドキュメントコメントの説明は以下のようになっている。

Visual C# では、ソース コード内で、参照先のコード ブロックの直前の特別なコメント フィールドに XML タグを配置することで、コードのドキュメントを作成できます。

要するに、C#にはドキュメントのためのコメントをつける機能があり、そしてC#コンパイラはドキュメント化機能を標準で備えているということである。

ちなみに、このドキュメントはXMLファイルで出力される。Visual Studioでチェックボックスを1つ入れるだけでビルド時に出力できるようになる。

XMLファイルから他の形式への変換

XMLファイルはプログラムなどで処理するには都合の良い形式だが、人間が利用するドキュメントとしては良い形式ではない。たとえば、MSDNのAPIリファレンスのような様式で表示されると嬉しいし、CHMファイルのように1ファイルでまとめてあると、なお嬉しいわけである。

そこで、XMLからCHMへとファイル形式を変換するためにツールを使用する。

変換ツール「Sandcastle」

私が使用したのは、「Sandcastle」というツールである。

Sandcastleはコマンドラインで使用するツールなので、「Sandcastle Help File Builder」というGUIインタフェースを提供するツールをあわせて使用する。さらにMSDNライクな形式(かつCHMファイル)で出力するために「HTML Help Workshop」をインストールする。

参考