【コメント】doxygen【コンソメ】

**デフォルトの名無しさん** · 2008/05/30(金) 19:50:27

無いので建てた

公式
http://www.doxygen.jp/

**デフォルトの名無しさん** · 2008/12/30(火) 01:23:34

過去のバージョンを取ってきて順に試してみました。
1.5.0までは日本語の RTF が生成できて
(おかしなところが無いかまではチェックしてませんが)、
1.5.1で、
"Warning: Output language Japanese not supported! Using English instead."
と表示され、日本語が表示できませんでした。
ここで一旦無かったことにされたようです。

**デフォルトの名無しさん** · 2008/12/30(火) 03:40:46

問題分かったかも。

id 437346 のバグレポートで日本語対応の議論がされてるんだけど、
報告者の人が提案した、
x080より大きいバイトが来たらマルチバイト判別フラグON、
次のバイトでフラグOFF、というのをそのまま採用してくれたらよかったのに、
0x80より大きいかの判断をそのままフラグに入れちゃってるから、
2バイト目が0x80より大きい場合に、その次のバイトまでエスケープされて、
それがエスケープされたら困るものの場合に不幸になってるということかと。

**デフォルトの名無しさん** · 2008/12/30(火) 03:58:34

repopかければいいのに。

rtfって何で読めるんだろう。AbiWord?ooo?

**デフォルトの名無しさん** · 2008/12/30(火) 08:55:13

>>123
事はそう単純じゃない。というか、もっと単純。
内部UTF-8をcp932に変換して、必要ならエスケープすべきなのにそれをしていないと言うのが>102=113の観測だろ。
例えば「ソソ」が「\'83\\\'83\\」にならないといけないのに「\'83\\'83\」になると。

それとも、二種類の問題が独立して存在しているのか?

**123** · 2008/12/30(火) 10:22:07

>>125
ああ、すいません。
>>123で書いたのは、1.5.8の場合の問題です。
>>102,,>>113の、.1.5.5の問題はエスケープされてないというので合ってると思います。
1.5.8でそれに対する対応が入れられたけど、方法がまずく、
今度は逆にエスケープすべきでないところまでされたという話。

**デフォルトの名無しさん** · 2008/12/30(火) 11:17:38

>>78
1.5.8で直った

**デフォルトの名無しさん** · 2009/01/08(木) 07:49:37

とりあえず保守ですが、あけおめ。

日本語rtf使えるようになるといいですね

自分はまだ皆様のようにハックに参加できるほど技術がないので、精進したいと思います。

**102** · 2009/01/08(木) 09:55:41

又更につまらない問題に遭遇。
折角修正したrtfがWordだと読めるのにOpenOfficeだと文字化けする。
例えば、「\'83\\」のような>125が指摘した例だと、「\'83\'5c」のようにしないといけないらしい。
あーもう、rtfを解析するしかないのかなぁ。
# doxygen1.5.8で変わっているらしいからそっちに手を出すのは避けたいし。

**デフォルトの名無しさん** · 2009/01/08(木) 22:19:22

解決しました。ありがとうございました。

**デフォルトの名無しさん** · 2009/01/10(土) 14:59:07

1.5.8 のrtfのエスケープバグのソースって
どのファイルなのかな？

**102** · 2009/01/10(土) 15:17:25

ちょっとLinuxに1.5.8をインストールしたので出力してみたが、これは酷いw
2バイト文字を全てコード出力しているのはいいが、>123のように無関係なコマンド文字まで巻き添えにしてしまっている。
おまけに、コマンド文字列を何故か\commentで括ってしまっているので収拾がつかない状態。

そうそう、html出力のツリービューも、(UTF-8)指定なのにも関わらずプロジェクト名がEUCで出力されるので化け化け。
誰かなんとかして～w
# ってことで、>131に期待♪

**デフォルトの名無しさん** · 2009/01/11(日) 01:06:49

うはｗ　ぼくとしては>102さんに期待してるんだけどっｗ

**デフォルトの名無しさん** · 2009/01/12(月) 00:56:25

>>131
rtfgen.cpp の void RTFGenerator::postProcess(QByteArray &a) です。
こちらを参考に。
ttp://bugzilla.gnome.org/show_bug.cgi?id=437346

>>132
そういや最近プロジェクト名を日本語にしてなかったけど、これは…

どうやらDoxywizardのバグのようです。
テキストエディタでDoxyfile開いてプロジェクト名を修正して、
コマンドラインでDoxygenを実行したら、文字化けしませんでした。

**デフォルトの名無しさん** · 2009/01/12(月) 02:36:31

>>134 ソース位置ありがとう。
これって、よくわかってないけど、postProcess()で、ファイル全体を
エスケープしてるのかな。
もしそうなら、rtfでの表示される文字列以外も全部エスケープされて
しまい、上のバグが症状がでてるんじゃないかな？
rtf表示文字列だけをエスケープするようにするには、postProcess()
の中でやってちゃだめで、rtfgen.cpp（にあるか知らないけど）
で表示文字列をrtfタグ中に埋め込む時コード当たりでやらないといけなそう？

とりあえず、doxygenをWindowsでコンパイル出来る環境作り
からやらないといけないのが辛いorz

**デフォルトの名無しさん** · 2009/01/12(月) 08:13:44

>>135
頑張れw
Cygwinなら協力する。
# つーか、ソース拾ってきて自分でやれ＞自分

**134** · 2009/01/12(月) 21:40:12

>>135
0x80より大きい値とmb_flagが1のときだけエスケープされるはずです。
1.5.7.1以前のバージョンではmb_flagが無くて、0x80より大きい値という条件しかなかったので、
マルチバイト文字の2バイト目が「{」や「\」などの場合におかしくなってました。

mb_flagをマルチバイト文字の1バイト目で1にすれば、
次のバイトが0x80以下でもエスケープされるという仕組みのはずですが、
mb_flagの設定方法がまずくて、２バイト目でクリアされなくて
さらに次のバイトまでエスケープされる場合がある、という状況です。

ttp://bugzilla.gnome.org/show_bug.cgi?id=437346
で、T.Matsuyama氏が提示したコードが正しく動くはずです。

＃そこまで分かってるな自分でやれ、と言われそうだ……
すいません、環境作りが荷が重いですorz

**デフォルトの名無しさん** · 2009/01/14(水) 22:11:56

バグ修正版バイナリ出来たよん。
http://www1.axfc.net/uploader/He/so/182473&key=doxygen
T.Matsuyama氏パッチそのままです。
ばっちりっぽいです。
102さん、134さんありがとｗ

**デフォルトの名無しさん** · 2009/01/14(水) 22:17:06

おー、これは凄い。後で試してみるか。

**デフォルトの名無しさん** · 2009/01/27(火) 01:28:30

てか、>>137のURLが示すバグをreopenして開発者に教えてあげればいいんじゃないの？
アカウント持ってないから誰でもreopenできる設定なのかはわからないけど

**デフォルトの名無しさん** · 2009/01/27(火) 07:49:20

いかん、未だ試せてない……

**デフォルトの名無しさん** · 2009/01/30(金) 01:55:55

コメントが一切ついてないソースに
関数の定義部分だけ自動的に
タグを生成してくれるツールないですか？

**デフォルトの名無しさん** · 2009/01/30(金) 02:14:58

>>142 ctags?

**デフォルトの名無しさん** · 2009/01/30(金) 07:39:05

>>142
このスレ的には、タグというとDoxyfileのタグのことになるのだがそれでいいのかい?

**デフォルトの名無しさん** · 2009/01/30(金) 07:42:20

@が付くやつがいい

**デフォルトの名無しさん** · 2009/01/30(金) 08:23:53

ドキュメントつけしてない関数も出力するオプション？

**139** · 2009/02/15(日) 17:55:27

やっと>138を試せた。取り敢えず、cygwinからでも使えることと日本語が化けないことは確認した。
但し、OpenOffice(3.0)では{comment[^{}]}を取り除く必要があったこととTITLEなどのフィールドは
巧く変換できなかったけれど、これは元からそうなのかもしれない。
今度機会があれば、素直にMSwordに食わせてみるとしよう。

**139** · 2009/02/17(火) 18:58:43

cygwinで>138を動かし、できたRTFをWORD2000に食わせた。
全選択してフィールドの更新、画像アンリンクのマクロを動かして、
docに名前を変えて保存。一応、スタンダロンで使える資料になるようだ。

で、画像アンリンクのマクロって需要あるかな。あるようならどっかで公開するけど。

**デフォルトの名無しさん** · 2009/02/28(土) 05:29:11

doxygenのライセンスってGPLですよね。
doxygenのコメントを書いたソースって公開しないと駄目ですか？

**デフォルトの名無しさん** · 2009/02/28(土) 05:39:00

ならないよ
GPLのお絵かきソフトで絵を描いたようなもん

**149** · 2009/02/28(土) 05:50:38

>>150
ありがとうございます

**デフォルトの名無しさん** · 2009/03/03(火) 10:33:16

DoxyfileもGPLに該当しないのかな。
それとも、コメント部分は削除しておいた方が無難?

**デフォルトの名無しさん** · 2009/03/03(火) 22:08:28

ソフトのドキュメントを作るのにDoxygenを利用してもGPLにする必要なし。
ソフトの機能としてDoxygenを利用する場合はGPL。

**デフォルトの名無しさん** · 2009/04/06(月) 21:16:11

@a と @p ってどう使い分けてる？
どっちも文中の引数のフォントを変えるために使うものみたいだけど。

**デフォルトの名無しさん** · 2009/04/08(水) 12:32:53

\aは「特殊なフォント」ということで一般的にはItalicかな。
\pは\cと等価で「タイプライタフォント」ということで等幅フォントが使われる。
後は、実際の出力を見て検討したら?

**154** · 2009/04/09(木) 00:04:14

普通はどうする、ということは特になくて、見た目の好みで使えばいいのですか。
ヘルプを見ると、@aは "refer to member arguments" 、
@pは "refer to member function parameters" と書かれてて、
微妙に使い分けがあるようなないような、よく分からなかったもので。

**デフォルトの名無しさん** · 2009/04/09(木) 07:14:32

意味で使い分ければいいと思う。
フォントとかの体裁はCSSで変えられるんじゃなかったかな？やったこと無いけど。

**デフォルトの名無しさん** · 2009/04/09(木) 08:11:53

@a の argument が実引数で @p の parameter が仮引数なわけだけど、
コメント中では仮引数しか現れない気がする。実引数が現れることなんてあるか？

**デフォルトの名無しさん** · 2009/04/09(木) 09:06:56

恣意的に使い分ければいいんじゃね?

>>157
出力するものによって指定するスタイルシートや指定方法は違うけど、htmlならcss,だね。
やったことないけどw

**デフォルトの名無しさん** · 2009/04/10(金) 04:10:58

member argumentがクラスのメンバー変数ってことはないかな。

**デフォルトの名無しさん** · 2009/04/10(金) 23:50:56

>>158
@p param1 の値が @a xxx だったら～
みたいな説明を書くのに使うとか?

**デフォルトの名無しさん** · 2009/04/25(土) 21:37:10

メソッドのコメントは、戻り値がなくても「@return なし」と明示的に書くべきでしょうか？
引数がない場合も同様に「@param なし」と書くでしょうか？

**デフォルトの名無しさん** · 2009/04/25(土) 21:38:20

前者はお好きにどうぞ。
後者は「なし」なんて引き数はないぞって警告が出るんじゃないかな?

**162** · 2009/04/25(土) 21:45:11

>>163
レスありがとうございました。
確認したら「@param なし」ではwarning argumentと出ましたのでこれは書かないようにします。

**デフォルトの名無しさん** · 2009/04/30(木) 13:43:57

今の大会は、開発環境の違いによる面白さもあると思う。
共通スペックでやるなら別に大会をおこせばよいと思う。

**デフォルトの名無しさん** · 2009/04/30(木) 13:45:15

>>165
誤爆しました。すみません。

**デフォルトの名無しさん** · 2009/04/30(木) 23:56:10

Doxygen 1.5.9 age

**デフォルトの名無しさん** · 2009/05/01(金) 00:16:08

さっきまでは1.5.8だったのに。早速試すぜ。

**デフォルトの名無しさん** · 2009/05/12(火) 10:55:11

ソースの先頭のコメントの理想的なサンプルを教えて。
言語は問わないけど、出来ればCで。

**デフォルトの名無しさん** · 2009/05/12(火) 18:22:26

理想的かどうか知らんが、私の典型。
--
////////////////////////////////////////////////////////////////
/// \file foo.c
/// \brief あーたらこーたら
///
/// あーたらこーたらをあーたらこーたらするとかなんとか。
/// \date 2009/3-4
/// \author bar\@site
/// \attention なんだかんだ
/// \version hage.hige.hoge
//
--

**デフォルトの名無しさん** · 2009/05/13(水) 04:06:28

>>169
とりあえず最小限はこうだろ。 JAVADOC_AUTO_BRIEF オンで。

/** @file
* 簡単な説明.
* 詳細な説明
*/

170 のやつだと、ファイル名はどうせ名前変更したときに更新し忘れるし、
日付や作者やバージョンはバージョン管理ソフトに任せればいい。
詳細な説明も attention も必要に応じて、だな。とにかく書かないで済むものは
書かないのが一番。

**デフォルトの名無しさん** · 2009/05/13(水) 09:19:41

>>170
ありがとうございます。

>>171
そのバージョン管理ソフトに書かせるので心配ゴム用です。

**デフォルトの名無しさん** · 2009/05/13(水) 16:20:47

表書くのってtableタグ使うしかないんでしたっけ？
それだとソース上で見づらいんで、
リストみたいに簡易記法があればいいんですけど。

**デフォルトの名無しさん** · 2009/05/13(水) 22:00:48

doxygenって使ったこと無いんだけど、
ぶっちゃけて言うと、オススメですかい？

**デフォルトの名無しさん** · 2009/05/13(水) 23:26:06

>>174
おすすめとは言えない

でも面白い使い道がある事は確か

実際に走らせてみて「おー」とか言って楽しむものだと思う

**デフォルトの名無しさん** · 2009/05/14(木) 09:55:19

>>174
クラス関連図とか、煩いクライアント向けのコーリングツリーを作るのに便利。
# 余程酷いソフトハウスに当たった経験があるのか、関数の依存関係を知りたがるクライアントがいるのよ。

**174** · 2009/05/14(木) 22:16:15

>>175-176
ほっほー。
ありがとう。
「ある程度習熟するために勉強を要してめんどくさそうだ」
と思っていたが、試してみようかなあ。

**デフォルトの名無しさん** · 2009/05/14(木) 23:43:40

>>177
コメント付いてないのも全部出力する設定で、
とりあえず手持ちのソースそのまま掛けてみたらいいよ。

それで出来上がるものが気に入れば、それから書き方に慣れていったらいいし。

**デフォルトの名無しさん** · 2009/05/14(木) 23:50:13

Graphvizの使い方が秀逸だと思う
これは出力結果を印刷してじっくり眺めたい

**177** · 2009/05/15(金) 06:46:11

>>178
ありがとう。分かった、そうしてみるわ。

**デフォルトの名無しさん** · 2009/05/15(金) 09:37:18

客先から小汚いソースを受け取ったら、取り敢えずDoxygenに掛けて
静的解析するのは基本だな。

**デフォルトの名無しさん** · 2009/05/15(金) 10:09:23

>>171
subversionとかの置き換えキーワードもdoxygenは認識してドキュメント化してくれる。

**デフォルトの名無しさん** · 2009/05/21(木) 13:35:09

ちょっと詳しい説明を箇条書きで入れたいんだけど、
空白行が入るとパラグラフが終わってしまうので、空白行を一切入れないで
長い文章を書かなきゃいけなくなり、なんていうか
ソースコードのコメントが非常に見づらい。本末転倒な気がするんだけど、
空白行を無視してくれる方法とか、ない？

**デフォルトの名無しさん** · 2009/05/23(土) 02:32:07

>>183
ソースコード上でだけ行間が空いてればいいのなら、
全角スペースを入れておけばどうでしょう？
ドキュメント上で行が連結されたときに、余分な空白が入りますが。

ドキュメントでも行間が空くようにしたいのなら、
行頭の邪魔にならないところにでも「@n」を入れておくぐらいしか思いつきません。

**デフォルトの名無しさん** · 2009/05/24(日) 13:15:10

doxygenの文字化け対策
ttp://d.hatena.ne.jp/kmt-t2/20090403/1238718375
ここに救われた俺がいる。

**デフォルトの名無しさん** · 2009/05/24(日) 14:01:52

doxygenであるライブラリのドキュメントを作った時、
そのライセンスってどこにどうやって記載すればいいの？

ドキュメント内に表示されるようにしたいんだけど。

**174** · 2009/05/24(日) 16:39:03

doxygen気に入ってきた。

C++とdoxygen最新版にて。

ドキュメント作ると名前解決に使う::がドキュメントにもりこまれたり盛り込まれなかったりする。
例えばNameS::MyClassが、
ドキュメントの100行目ではNameS::MyClassになっているのに
101行目ではNameSMyClassになっていたりする。

これはどう解決すればいい？

**デフォルトの名無しさん** · 2009/05/25(月) 10:31:42

>>187
このレスの流れを見ても分かるように、Doxygenは文字コードの扱いが未だ未だ不安定だったりする。
あんたの言う、「ドキュメント」がrtf出力ならこのスレにある対策版を使ってみた方がいいかもしれないし、
chm出力なら>185を参考にするといいかもしれない。

**デフォルトの名無しさん** · 2009/05/25(月) 20:01:17

>>186
@mainpageコマンドでメインページに入れるか、
@pageコマンドで独立したページにすればどう？

**174** · 2009/05/25(月) 23:27:45

>>188
ありがとう。
説明不足だったね。
ドキュメントはフツーのHTMLなんだよね～。chmじゃなくて。

>185をやってみたら文字化けは解消したんだけど
>> ドキュメントの100行目ではNameS::MyClassになっているのに
>> 101行目ではNameSMyClassになっていたりする。
この現象は解決しないのだ。。。

**186** · 2009/05/25(月) 23:41:59

>>189
@pageコマンド
なんて初めて知ったわ。

どこかいい解説サイトとか紹介してくれる
お方、いらしたらお願い！

**デフォルトの名無しさん** · 2009/05/27(水) 12:59:53

>>191
doxygenに付いてくるサンプルも参考になるよ。
当然全部英語だけど、記述例のソースと
それを使って出力されたドキュメントがある。
コマンドの説明が知りたかったら、
>>1 のサイトの日本語版マニュアルを見ればいいし。

**186** · 2009/05/27(水) 19:11:01

>>192
そうか、ありがとう。
見てみるよ。

**デフォルトの名無しさん** · 2009/05/28(木) 03:59:47

いつの間にかDoxywizardもだいぶ使いやすくなったんだな

**186** · 2009/05/28(木) 06:28:18

俺は最近doxygenを使い始めて、
最初に
Doxywizard
を使ってかなり直感的に操作できたから知らなかったが、
そうなのか。前は使いづらかったのか。

grach

**デフォルトの名無しさん** · 2009/05/30(土) 12:54:18

#defineマクロ定義をドキュメント(html)に出力させたくて
ttp://www.doxygen.jp/commands.html#cmddef
ここを見て

C++ code - 19 lines - codepad
ttp://codepad.org/mUM77yZO

こんなの書いてみたんですが、
全然#defineマクロ定義が出力されません。

どうすれば良いでしょうか？

**デフォルトの名無しさん** · 2009/05/30(土) 17:17:56

>>196
define_test.h のファイルのページ自体は出来てる？
実際のファイル名と @file の後ろに書いたファイル名が合ってないとかはないかな、と思ったもので。

**196** · 2009/05/30(土) 23:13:55

>>197
ttp://loda.jp/uploader_nrnrnr/?id=2
こんなHTMLが生成されました。

どうなんでしょう。。。？

**197** · 2009/05/31(日) 00:25:04

>>198
define_test.h ファイルのドキュメントのページができてないね。
>>196 のソースをコピペして同じ名前で保存してみたけど、
こっちじゃちゃんと出力されてるよ。

Doxyfile 晒してもらえるなら、何が違うか比べてみるけど。

**197** · 2009/05/31(日) 00:31:38

>>198
もしかして、SHOW_FILESがOFFになってない？
Doxywizard使ってるなら、ExpartのBuildの下の方。

**196** · 2009/05/31(日) 04:59:33

>>200
丁寧にありがとうございます。
Doxyfileは以下です。
C++ code - 1503 lines - codepad
ttp://codepad.org/aNCHcRW3
お願いします。

**196** · 2009/05/31(日) 05:04:41

追記：
　　SHOW_FILES=NOになっていましたが、
　　YESにしても変わりませんでした。
　　私の環境は
　　windows xp sp2
　　doxygen 1.5.9です。

**197** · 2009/05/31(日) 05:45:10

>>201
WARN_IF_DOC_ERROR を ON にしたら判明した。
ENABLE_PREPROCESSING が OFF だとマクロは見てくれないらしい。

**197** · 2009/05/31(日) 05:51:37

補足

WARN_IF_DOC_ERROR を ON にしたら、
「マクロにコメント書いてるけど、ENABLE_PREPROCESSINGがOFFだからスキップしたよ」
というようなメッセージが表示された。

**196** · 2009/05/31(日) 14:59:44

>>204
ありがとうございます。
WARN_IF_DOC_ERRORとENABLE_PREPROCESSINGをYESにしてみましたが、
結果は代わりありませんでした。
Doxyfileはこちらです。
ttp://codepad.org/rsH3deU0
設定を読み込み直していないなどということはなく。
doxygenのウィンドウに表示される情報は
ttp://codepad.org/bqYOU7ug
の通りです。

すみませんがよろしくお願い申し上げます。

**196** · 2009/05/31(日) 22:27:30

追記：
　　テキストエディタでDoxyfileを開き、
　　= NO
　　を検索して全て
　　= YES
　　に置換してみました。
　　それでdoxygenを走らせたところ、見事#defineは出力されました。
　　やはり設定が問題な様です。

**196** · 2009/05/31(日) 22:43:14

どこの設定が問題なのか探るために
Doxyfileにて二分木法的にNOをYESに置換してみました。

ファイルのど真ん中の行を基準に上だけないし下だけを
全部NO→YES置換を行いました。

しかし、このどちらも#defineが出力されません。
やはり複数の設定項目が関わっているようです。

**196** · 2009/05/31(日) 22:56:12

解決しました。

正解は
・ENABLE_PREPROCESSINGをYESにする。
・SHOW_FILESをYESにする。
でした。両方が同時に満たされていないとだめなようです。

お手数をおかけ致しました！

**197** · 2009/06/01(月) 01:23:37

>>205-208
解決したようなのでもういいかもしれないけど、
WARN～系の設定は、出力状態を変更させるためのものではなくて、
コメント付けてるのに出力されない設定になってるとか、
記述漏れがあるとか、そういうエラーメッセージを表示するためのもの。

今後何かうまくいかないときに参考になるかもしれないので念のため。

**196** · 2009/06/01(月) 05:54:55

>>209
はい、WARN～系の設定に関して、よく頭に入れておきます。

ありがとうございました。

**デフォルトの名無しさん** · 2009/06/01(月) 23:20:24

Windows XP SP2, doxygen 1.5.9です。
htmlドキュメントを生成すると、
本文中のstd::coutのようなスコープ解決演算子が消えてしまい、
stdcoutになってしまうことが多々あります。
再現するソースやその結果のhtml, Doxyfileは以下の様です。
ttp://loda.jp/uploader_nrnrnr/?id=3

具体的にはこのソースにて
　Test::foo()は
　numをstd::coutに出力します。
になるはずが
　Test::foo()は
　numをstdcoutに出力します。
になってしまいます。

再現条件は絞れておりません。
どうかお知恵をおかしください。
よろしくお願い申し上げます。

**デフォルトの名無しさん** · 2009/06/02(火) 02:54:51

>>211
理由はよく分からないけど、std::coutの前後に空白を入れたら正しくなりました。
識別子っぽいものに非ASCII文字がくっついてたらおかしくなるってことじゃないかと思うんですが。

**211** · 2009/06/02(火) 06:08:56

>>212
たしかに、前後に空白で正しく表示されます。
本当に適用したいソース(再現用ソースでない)でもうまく表示されます。
ありがとうございました。

**デフォルトの名無しさん** · 2009/06/02(火) 23:53:16

>>195
今のdoxywizardはver.1.5.8(去年の暮れ頃)からですね。

基本的な設定項目だけのwizardモードと、
設定可能な項目が全部表示されるexpertモードの２本立てというのは
昔も今も変わりませんが、
設定を変えたら保存しないと実行できなかったとか、
設定項目のセクション切り替えがタブで、expertモードだと
たくさん並んでるのをぐるぐるスクロールさせる必要があったとか、
細かいところで少し不便でした。

マニュアルに載ってるスクリーンショットは旧バージョンのような気がします。

**デフォルトの名無しさん** · 2009/06/02(火) 23:58:29

doxygenで、1カ所に書いたコメントを複数箇所で参照する方法はありますか？

例えば、
hoge.h内で@version 1.1.1
という記述が同じhoge.h内で他にも複数箇所に登場する場合、
全部に@version 1.1.1と書いてしまうとバージョンを上げる時に
全箇所を手動で修正する羽目になってしまいます。

どうにかする手段はありますか？

**デフォルトの名無しさん** · 2009/06/03(水) 02:07:50

>>215
設定ファイルのALIASESで@version 1.1.1に別名をつければ、
バージョンを上げるときはそこだけ変えればOK

というのはどうでしょう？

**デフォルトの名無しさん** · 2009/06/03(水) 03:43:33

質問です。

いままでのプログラムは以下のようにコメントしていたのですが、
doxygenでは/** */の形式にしないとドキュメント作成はできないのでしょうか？
コメント部分を目立たせたいので、できれば今までのコメント形式を維持したいのですが・・

今までのコメント例
//********************************************************
// Test.cpp
// 2009.09 by Tester
// テスト用のクラス
//********************************************************

これを
/**
*
*
*
*/
形式にするのは少し抵抗があります

**デフォルトの名無しさん** · 2009/06/03(水) 08:40:05

>>217
特定の形式にしないと、ドキュメントにしないコメントと区別できないですからね……

使えるコメント形式はマニュアルの「Documenting the code」にいろいろ例があります。
(日本語マニュアルは古くて少し情報が少ないです)

今までのに比較的近いのは
/*****************************************************//**
* Test.cpp
* 2009.09 by Tester
* テスト用のクラス
*********************************************************/
でしょうか。

**デフォルトの名無しさん** · 2009/06/03(水) 10:41:33

>>217
最初と最後の //****** はそのままで、途中の行だけ先頭の//を3文字にすればいい

**デフォルトの名無しさん** · 2009/06/03(水) 10:48:32

つまり、こうだな。
//********************************************************
/// \file Test.cpp
/// \date 2009.09
/// \author Tester
/// \brief テスト用のクラス
//********************************************************

**デフォルトの名無しさん** · 2009/06/03(水) 16:06:28

>>217
俺も抵抗があったけど、
変えてみたら意外と平気だったよ。
要は見慣れるかどうか。

**デフォルトの名無しさん** · 2009/06/03(水) 16:09:51

>>216
ALIASES
なんてものがあるのですね。
ありがとうございます、試してみます。