Doxygen

なかなか Doxygen で書いたコメントがきれいにならないと悩んでいましたが、今日やっと理由がわかりました。いつも関数中のコメントも Doxygen 用の書き方をしていたのですが、そうするとすべて関数の説明になってしまいます。

int

main(int argc, char *argv[])

{

	/*! 初期化処理

	 */

	init_hoge();

例の main() 関数の説明として【初期化処理】があらわれてしまいます。この場合、

int

main(int argc, char *argv[])

{

	/* 初期化処理

	 */

	init_hoge();

と、書けばきちんとコメントも残るし main() の説明に余計な物がつかなくなります。常識なのかもしれませんが、Doxygen で書くときは全部 Doxygen用のコメントとして書かないといけないと勘違いしていたのもで・・・