.NET Tips: C#で XML コメントからヘルプを作成
■ Visual Studio の HTML ヘルプ作成機能
C# では XML コメントを書くことで、HTML ヘルプをコードから自動生成することが出来る。
※ 尚、VB.NET では次期バージョン (2005) から、この機能に対応する。
- MSDN ― コード コメント Web レポート
- @IT ― Visual C# .NETでAPIリファレンスを作る
Visual Studio では、メニューから「Web ページのビルド コメント」を選ぶことで、コードの XML コメントからHTML ヘルプ作られる。
但し、この機能で作られた HTML ヘルプは、Windows XP SP2では見ることができない。
参考:
■ NDoc の紹介
“NDoc” というツールを使うことで、MSDN のような HTMLヘルプ形式 (.chm ファイル) を含む様々なヘルプ形式を出力できる。
※ プロジェクトのプロパティで「XML ドキュメント ファイル」を指定しておく必要がある。
NDoc の使い方はこちらを参考に。