以前から気にはなっていたけど使わなっかったDoxygenを使う気になったので メモメモ
まず、自分はコメントとして///(スラッシュ3つ)使うのが好きなのでこれを採用
この場合、一行のみのコメントだとbriefになって、複数行続くと勝手にdetailになるようです。便利!
doxygenのはまりどころとしては、
VisualC++(2010以前で確認)ではソースファイルはデフォルトでShift-JISになります。
ソースコードのエンコーディングをDoxygenに教えるにはINPUT_ENCODINGのオプションを使います。
また、Doxygenが出力するファイルのエンコーディングはDOXYFILE_ENCODINGオプションを使います。
しかし、DoxygenのINPUT_ENCODINGをShift-JISに、DOXYFILE_ENCODINGをUTF-8にして、Doxygenのコマンドに使うと円マークとバックスラッシュの変換が都合よく行かず、
結果として、Doxygenコマンドを認識できないという問題があります。
(参考:http://blogs.yahoo.co.jp/onion_developer/5791986.html)
JavaDocスタイルのコマンドでは@マークを使うため、このような問題は起こりません。
しかし、texを入れてtexコマンドを使おうとしたときに同様の問題にぶつかります。
(自分はこちらに引っかかった)
そこで、回避策としてはINPUT_ENCODINGはCP932 を指定しましょう。
こうすると、Doxygenの中で円マークをうまくバックスラッシュとして読んでくれて、コマンドが通るようになります。