[C++] Doxygen

C++でも自動でドキュメント生成してくれるツールあるに決まってるよなってことで、調べたら、Doxygenっていのが一般的っぽいんで、これを使うことにした。ヘッダコメントとかもDoxygen対応の書式にした。

インストールしたら、DoxywizardってGUIのツールができるから、これ使ってちょっと設定変えて、[Start]ボタン押すだけでドキュメントが生成できた。

コメントの書き方は、QtスタイルとJavaDocスタイルがあるけど、自分はJavaDocスタイルに慣れてるからこれを使うことにした。

設定をいじったとこは、

• [OUTPUT_LANGUAGE]をJapaneseへ
• [INPUT_ENCODING]をShift_JISへ
• privateメンバを表示するように、[EXTRACT_PRIVATE]を有効へ
• コメント1行目の概要を表示するように、[JAVADOC_AUTOBRIEF]を有効へ
• ファイル一覧でフルパスが表示されないように、[FULL_PATH_NAMES]を無効へ

ってとこかな。

で、ヘッダコメントは↓こんな感じにした。

• ファイルヘッダ

/**
 * @file Di.h
 *
 * @brief DirectInput処理
 *
 * @author 1122
 * @date 2008/01/18
 */

• クラスヘッダ

/**
 * DirectInput処理
 *
 * @author 1122
 * @date 2008/01/18
 */

• 関数ヘッダ

/**
 * DirectInput初期化
 * 
 * @param[in] a_hWnd ウィンドウハンドル
 * @param[in] a_hInstance インスタンスハンドル
 * 
 * @return 処理結果
 * @retval true 成功
 * @retval false 失敗
 */