2004/08/31(火)doxygenあれこれ
2004/08/30 25:00
とりあえず、当面我が家でのコメントの書き方。
//! ジャンル判定２（曖昧） (*! @par 指定文節のかっこを除去した文字列が、あらかじめ読み込んでおいたGenreList中の文字列に”含まれる”かどうかを判定する。 @param id [in] 文節番号 @return 含まれるならばTrue、そうでないならFalse *) procedure / function...
重要なのはここらあたりだろう。出来れば詳細ブロック内でもHTMLタグは書きたくない。
どちらがメジャーか分からないが、JavaDocよりはQtスタイルで良し。
参考： http://members.at.infoseek.co.jp/sakura_editor/comment-rule.html
引数には、[in],[out],[i/o]を書けという指示があったがデファクトだろうか？ （doxygenではピックアップされない）
ところで、関数説明部のタグは<dl compact>となっている。そのため、短いパートによっては行変えが行われないなどなんかいまいちな仕様。compactは推奨されないはずでは？ ソースのhtmlDocVisitor.cppをいじれば何とかなりそうではあるが、やりたくない以上に今コンパイル環境がない。まあ、やりたくなったら。あ、BCBでいけるか？
さて、スタイルシートもいじったのだが、長くなりそうなので次項に回す。