このブログは、旧・はてなダイアリー「檜山正幸のキマイラ飼育記 メモ編」(http://d.hatena.ne.jp/m-hiyama-memo/)のデータを移行・保存したものであり、今後(2019年1月以降)更新の予定はありません。

今後の更新は、新しいブログ http://m-hiyama-memo.hatenablog.com/ で行います。

DoxygenのMarkdownファイルはソースファイル

Doxygen自動リンク機能は強力で便利で、一度使い出すとやめられない。md(markdown)でも自動リンク構文が使える。

ソース内のドキュメンテーションコメント以外に、独立したmdファイルのドキュメントも書いている。自動リンクを使い出すと、mdファイルも、プロジェクトのソースファイル群の一部と考えなくてはならない。

例えば、ファイル/クラス/関数/変数などをリネームすると、mdファイルからの自動リンクも切れてしまうので、変更はmdファイルも含めて行わないといけない。grepするときも、*.{cpp,h,md} のようにgrepする。

作業の負担は増えるのだが、全体としては、ソースと整合したDoxygenドキュメントがあるのはメリットが大きいので、ソースとしてmdファイルもメンテナンスしたほうがいい。