LoginSignup
42
62

More than 5 years have passed since last update.

Doxygenチートシート

Last updated at Posted at 2018-09-19

Qiita初投稿。
練習も兼ねてDoxygenのチートシートを投稿します。

Doxygenチートシート

Doxygenについてはこちらを参照

ソース・ヘッダーファイルテンプレート

////////////////////////////////////////////////////////////////////////////////
/// @file           ファイル名
/// @brief          ファイルの説明
/// @author         作成者
/// @date           ファイル作成年月日
/// $Version:       ファイルバージョン$
/// $Revision:      ファイルリビジョン$
/// @note           ファイルに備考などを明記する場合はここへ書き込む
/// @attention      ファイルに注意書きなどを明記する場合はここへ書き込む
/// @par            History
///                 ファイルに履歴などを明記する場合はここへ書き込む
///
/// Copyright (c) YYYY Sample Inc. All Rights reserved.
///
/// - 本ソフトウェアの一部又は全てを無断で複写複製(コピー)することは、
///   著作権侵害にあたりますので、これを禁止します。
/// - 本製品の使用に起因する侵害または特許権その他権利の侵害に関しては
///   当社は一切その責任を負いません。
///
////////////////////////////////////////////////////////////////////////////////

関数・メソッドコメントテンプレート

////////////////////////////////////////////////////////////////////////////////
/// @brief          関数の説明
/// @fn             関数名
/// @param[in]      引数(参照専用)
/// @param[out]     引数(ポインタ引数等)
/// @return         関数戻り値の説明
/// @author         関数作成者名
/// @date           関数作成年月日
/// @version        関数やソースにバージョンを明記する場合はここへ書き込む
/// @note           関数に備考などを明記する場合はここへ書き込む
/// @attention      関数に注意書きなどを明記する場合はここへ書き込む
/// @par            History
///                 ファイルに履歴などを明記する場合はここへ書き込む
///
////////////////////////////////////////////////////////////////////////////////

CLASSコメントテンプレート

////////////////////////////////////////////////////////////////////////////////
/// @class      class名
/// @brief      classの説明
///
////////////////////////////////////////////////////////////////////////////////

構造体コメントテンプレート

////////////////////////////////////////////////////////////////////////////////
/// @struct     構造体名
/// @brief      構造体の説明
///
////////////////////////////////////////////////////////////////////////////////

enum型コメントテンプレート

////////////////////////////////////////////////////////////////////////////////
/// @enum       enum型名
/// @brief      enum型の説明
///
////////////////////////////////////////////////////////////////////////////////

defineコメントテンプレート

////////////////////////////////////////////////////////////////////////////////
/// @def        define名
/// @brief      defineの説明
///
////////////////////////////////////////////////////////////////////////////////

typedefコメントテンプレート

////////////////////////////////////////////////////////////////////////////////
/// @typedef    typedef名
/// @brief      typedefの説明
///
////////////////////////////////////////////////////////////////////////////////

変数コメントテンプレート

////////////////////////////////////////////////////////////////////////////////
/// @var        変数名
/// @brief      変数の説明
///
////////////////////////////////////////////////////////////////////////////////

構造体・CLASSメンバーコメントテンプレート

    HBRUSH      m_hbr;      //!< コントロールの表面を描画するブラシ.

Latexの式をインクルードするテンプレート

#define THUMB_RGB565_SIZE           28800       //!<RGB565タイプのサムネイルサイズ @f$(160 * 90 * 2)@f$

複数行にまたがるLatexの式をインクルードするテンプレート

/*
@f[
    (1 + 2 + 3) +
    (4 + 5 + 6) +
    (7 + 8 + 9) +
@f]
*/

コメントをリスト化するテンプレート

////////////////////////////////////////////////////////////////////////////////
/// @note
///         - 親リスト1
///             - 子リスト1
///             - 子リスト2
///         - 親リスト2
///             - 子リスト1
///             - 子リスト2
///
////////////////////////////////////////////////////////////////////////////////

リスト化注意事項
- リストの終わりは必ず空行を入れること
- TABサイズをテキストエディタとDoxygenとで同じにすること

リスト名を指定してリスト化したい時のテンプレート

////////////////////////////////////////////////////////////////////////////////
/// @par    リスト名
///         - 親リスト1
///             - 子リスト1
///             - 子リスト2
///         - 親リスト2
///             - 子リスト1
///             - 子リスト2
///
////////////////////////////////////////////////////////////////////////////////

子リストにA,B,C・・・等の記号を付けたい時のテンプレート

////////////////////////////////////////////////////////////////////////////////
/// @par    リスト名
///         - 親リスト1
///             -# 子リスト1
///             -# 子リスト2
///         - 親リスト2
///             -# 子リスト1
///             -# 子リスト2
///
////////////////////////////////////////////////////////////////////////////////
42
62
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
42
62