コードからリファレンスを作る

.NET

　ここ2週間ほど、友人や学校の先輩や前の会社から仕事の依頼がどんどん入ってきてアワアワしてました。そのうち2つはだめになって、もうひとつは交渉中。仕事を頂くというのは難しいですね。でも、声を掛けて頂けるという事はとてもありがたいことです。今回はご協力できなくても、そこから枝葉が広がっていけば良いと思っています。

JavaでコードからAPIリファレンスを作る Javadoc というのがあります。フォーマットに沿ったコメントでメソッドやクラスの概要・引数・戻り値などを書いておくと、それらの情報をHTMLに吐き出してくれるというやつ。「多分.NETでもあるんだろうな～」と思っていたが、調べて実装するのを怠っていました。 リファレンスを作っておくと便利だし、納品物として要求するお客さんもいるかもしれないので、癖にしておこう。これからチェックアウトするソースはコメントを書き直す。

参考：＠IT > Insider.NET > VS.NETによるチーム開発事始め > Visual C# .NETでAPIリファレンスを作る（前編） よく見ると、Microsoft MVPの方々のソースは、ちゃんとフォーマットに沿ったコメントを書いてますね。参考になります。

2005/12/02追記 VS2003ではVBの"説明"はリファレンスに反映されないらしい。例えば

'/ <summary>
'/ メソッドの説明
'/ </summary>
'/ <param name="aaaa">引数の説明</param>
'/ <returns>戻り値の説明</returns>

では太字の部分。時期バージョンではサポートされるとかされないとか。 Todo:2005が来たら試してみる。