ネタ元：ドキュメントの生成方法
いらっしゃいませ。当店は怪しげな健康ドリンクを提供するお店です。罰ゲームの一気飲みをする場合等にご利用ください。
なお、当店の入店資格は .NET Framework 2.0 以降、Visual Studio 2005 Standard Edition 以上となっております。それ以外の方はご利用にはなれません。
さて、今回は.NETでJavadocのようなドキュメントに加工する方法です。「生成」でなく「加工」である点にご留意ください。
Javadoc でのドキュメントは /** ～ */ のコメント記述のもとに生成されます。
では、C#ではどうでしょうか？ /// でコメントを書けば良いのです。
VB.NET では？ ''' で書けば良いのです。
どちらも、普通にコメントを入れる場合より一つ余分に記号を入れて書けば良いだけですね。
では、コメントを書いたら、次はどうするかですが……え？コメントの記述フォーマットはどうするんだ、ですって？
Standard Edition 以上なら、メソッドの直前行で /// (VBなら ''' ) を入れてみてください。何も悩むことはありませんよね？
え？わからない？……あなた、もしかして Express Edition を使ってはいませんか？
テンプレートに従って一通りコメントを入れ終わりましたら、プロジェクトのプロパティをお開きください。ビルド(もしくはコンパイル)を見ると、"XMLドキュメントファイル" の項目がありますよね。そこにチェックを入れておきましょう。
え、そんな項目はない？ですから、申し訳ありませんが Express Edition の方は今回お引取りをお願いします。 それでもなんとかしたいということであれば、.NET Framework SDK のコマンドラインでオプション指定をがんばってみていただけますでしょうか？
では、ビルド(コンパイル)してみましょう。
exe や dll ファイルと一緒に XML ファイルができていますよね。おめでとうございます。これでドキュメントの生成が終わりました。
……というわけには参りません。
XMLファイルのままでは Javadoc のように簡単に参照はできません。
そこで登場するのがこのドリンク、「砂上の楼閣」です。
Sandcastle をインストールしてみましょう。この辺に行けば、CTP版が入手できます。動作条件は各自ご確認ください。
Sandcastle だけではコマンドラインでの処理が大変なので、Sandcastle Help File Builder も入れておきましょう。この辺に行けば入手できます。これでGUIベースで使えるようになりましたね。
で、先ほどのXML ファイルをこのツールに与えてみましょう。これで ヘルプファイルができがありました。
今宵のドリンクはいかがでしたでしょうか。
え、具体例がない？特に後半端折りすぎ？
申し訳ございません、実はここだけの話ですが、当店のマスターも Express Edition しか持っていないので、これ以上は示すことができないのです。
違法営業で摘発される前に、店をたたむことにいたしましょう。
＃ひー、ごめんなさいごめんなさい。一度やってみたかったんですー。