.NET Tips: C#で XML コメントからヘルプを作成 (プログラミング C#

.NET Tips: C#で XML コメントからヘルプを作成

■ Visual Studio の HTML ヘルプ作成機能

C# では XML コメントを書くことで、HTML ヘルプをコードから自動生成することが出来る。
※ 尚、VB.NET では次期バージョン (2005) から、この機能に対応する。

Visual Studio では、メニューから「Web ページのビルドコメント」を選ぶことで、コードの XML コメントからHTML ヘルプ作られる。

但し、この機能で作られた HTML ヘルプは、Windows XP SP2では見ることができない。

参考:

■ NDoc の紹介

"NDoc" というツールを使うことで、MSDN のような HTMLヘルプ形式 (.chm ファイル) を含む様々なヘルプ形式を出力できる。
※ プロジェクトのプロパティで「XML ドキュメントファイル」を指定しておく必要がある。

NDoc の使い方はこちらを参考に。

中西庸文:

私のお気に入りは、NAntのndocタスクをちょっぴりいじって、こいつでHTMLヘルプ出力してやる方法です。

Fujiwo:

中西さん、こんにちは。

NAnt に関するすばらしい資料ですね。なんて詳細な。
ありがとうございます。

コメントを投稿

(いままで、ここでコメントしたことがないときは、コメントを表示する前にこのブログのオーナーの承認が必要になることがあります。承認されるまではコメントは表示されません。そのときはしばらく待ってください。)

名前:

メールアドレス:

URL:

この情報を登録しますか?

コメント: (スタイル用のHTMLタグが使えます)

About

2005年03月09日 09:24に投稿されたエントリーのページです。

ひとつ前の投稿は「.NET Tips: VC++ から来た人向け」です。

他にも多くのエントリーがあります。メインページやアーカイブページも見てください。