• このエントリーをはてなブックマークに追加

前回の記事では、Doxygenの導入をまとめたので、
ここではC言語/C++で使えるコメント(Doxygenタグ)の記入方法をまとめる。
公式サイトには、全てのコメント使用例が書いてあるが、ちょっと多すぎる。

http://www.doxygen.jp/commands.html#cmdparam

Doxygenの基本コメントまとめ

doxygenコメントは冒頭に /*! をつける。
C言語ソースでよく利用する(?)コメント(タグ)を列挙する。

共通でよく使う

@brief 説明文

 

  • インデントをそろえたハイフン’-“で箇条書きが表見できる。
  • /*@{*/ と/*@}*/ で囲むことで、グループ化できる。

ファイルヘッダ関係

@file ファイル名
@date 日付
@author 作者
@version 版数/バージョン
@par ユーザ定義の記述

 

/*!
* @file sample.c
*
* @dateツꀀツꀀツꀀ Created on: 2012/09/05
* @authorツꀀ Author: きつね
* @version 1.0
* @briefツꀀSツꀀ GoogleMock実験用
* @parツꀀツꀀツꀀツꀀ History 新規作成
*/

image

宣言関係

これらの宣言は、ファイルのどこかに @fileと記載されている必要がある。

@struct 構造体
@enum 列挙型
@def 定義
@var グローバル変数

 

/*! @struct NUM
*ツꀀ @briefツꀀ ナンバー
*/
typedef struct NUM
{
int num;ツꀀツꀀツꀀツꀀ /*!< 数ツꀀツꀀツꀀツꀀツꀀツꀀ */
int count;ツꀀツꀀ /*!< カウント */
}NUM;

/*! @struct RET
*ツꀀ @bruefツꀀ 戻り構造体
*/
typedef struct RET
{
int ret;ツꀀツꀀツꀀツꀀ /*!< 戻り値ツꀀツꀀ */
int count;ツꀀツꀀ /*!< カウント */
}RET;

/*!@def
* @brief 数の上限
*/
#define NUM_MAXツꀀ 10

/*!@enumツꀀ collor
* @brief 色
*/
typedef enum{
red,ツꀀツꀀツꀀツꀀ /*!<赤 */
blue,ツꀀツꀀツꀀ /*!<青 */
yellowツꀀツꀀ /*!<黄色 */
}collor;
  • メンバの説明は、/*!< hogehoge */ でも書ける。

image

関数ヘッダ関係

 

@fn 関数宣言
@breaf 要約説明
@param param <引数名> { 引数説明 } 関数の引数
param[in] 入力フォーマット
param[out] 出力フォーマット
param[in,out] 入出力フォーマット
@return { 戻り値の記述 } 戻り値の記述
@detail 詳細説明

 

/*!
* @fnツꀀツꀀツꀀツꀀツꀀツꀀツꀀ get_ret
* @brief
* @param[in] void
* @returnツꀀツꀀツꀀ 結果の数
* @detailツꀀツꀀツꀀ 数をライブラリから取得し、その結果によって処理を分岐する
*/

image