Doxygen 向け C/C++ ファイルのコメントテンプレート - l1o0の日記
Doxygen 高機能なんだけど、高機能すぎてどうやって Doxygen 用のコメントを書けばいいのかよくわからん。コメントとルール作りも兼ねてテンプレートを作っておこう。 Doxygen のいいところはソースコードが可視化されることもあるけど、コメントを付けてないとソースコード解析時に「コメントが付いとらん」と警告してくれるところ。さぼってコメントを付けないのを防いでくれる。 Doxygen C/C++ テンプレート comment.c /**********************/ /* ファイルヘッダの例 */ /**********************/ /******************************************************************************/ /*! @addtogroup モジュール名_サブモジュール名
doxygenのメモ
はじめに インストール 使い方 Wizardボタンでの設定内容 Expertボタンでの設定内容 ドキュメント化 @author @brief @ef @example @date @note @sa @param @return @retval @file @mainpage @attention @deprecated @exception/@throw @par @version 参考 はじめに doxygenはC/C++/Javaのソースを解析し、ドキュメントを生成するツールです。 簡単に言ってしまえば、JavaDocと同じようなものです。 doxygenとGraphvizを組み合わせると、UMLの図もドキュメントに組み込まれます。 doxygenもGraphvizもいろいろなプラットフォームのバイナリが提供されています。 doxygenとGraphvizは下記のサイトから入
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Has anyone used Sphinx to document a C++ project?
uhaku @Wiki - doxygen+graphviz
JavaやC++(オブジェクト思考)のソースから、設計を理解するために、 必要なポイントを教えてください。…
