tips - SHFB によるヘルプファイル作成

　SHFB によるヘルプファイル作成方法を紹介します。

ページ内リンク

• 概要

概要

　Visual Studio ではドキュメントコメントといって、 クラスや変数に対してコメントを付与することができます。 ドキュメントコメントを持つクラスや変数等を使おうとすると、 Intellisense 機能によって入力候補が表示されますが、 そのとき、付与されたドキュメントコメントが表示されるようになります。

　つまり、ドキュメントコメントによってユーザ側に そのクラスなり変数なりの使い方を瞬時に伝えることができるようになります。

　さらに、ビルド設定の出力設定には xml ファイルを出力する設定がありますが、 これは public なクラスや変数等に対するドキュメントコメントを xml ファイル形式で出力するための機能です。 この機能によって、例えばクラスライブラリを配布するときに、 この xml ファイルも同時に配布することで、 他の人も同様に Intellisense 機能によってドキュメントコメントが表示されるようになります。

　このように便利なドキュメントコメントではありますが、 さらに、SHFB というソフトではこの xml ファイルを利用して、 MSDN ライブラリのような形のヘルプファイルを作成します。 この SHFB というソフトについて使用方法を少しまとめた pdf ファイルを公開します。 興味のある方は参照して下さい。

SHFB によるヘルプドキュメント作成方法 (pdf:1.08MB)