Doxygen【汎用ドキュメントジェネレータ】

/// @file
/// @brief ファイルの概要
/// @author ファイルの開発者
/// @date ファイルの作成日
/// @details ファイルの詳細

/// @brief 名前空間の概要
/// @details 名前空間の詳細
namespace MyNamespace
{
}

/// @file

/// @brief マクロの概要
/// @details マクロの詳細
#define DEF_ONE 1

/// @file

/// @brief 型定義の概要
/// @details 型定義の詳細
typedef unsigned int UINT;

/// @file

/// @brief 列挙型の概要
/// @details 列挙型の詳細
enum MyEnum
{
    ENUM_1,  ///< 列挙子１の概要
    ENUM_2   ///< 列挙子２の概要
};

/// @file

/// @brief グローバル変数の概要
/// @details グローバル変数の詳細
int GlobalVar;

/// @file

/// @brief グローバル関数の概要
/// @details グローバル関数の詳細
/// @param [in] p 引数の説明
/// @return 戻り値の説明
int GlobalFunc(int p) {
    return p;
}

/// @brief クラスの概要
/// @details クラスの詳細
class MyClass
{
public:
    int varPublic = 0;  ///< 変数の概要

    /// @brief コンストラクタの概要
    /// @details コンストラクタの詳細
    /// @param [in] p 引数の説明
    MyClass(int p) {

    }

    /// @brief メソッドの概要
    /// @details メソッドの詳細
    /// @param [in] p 引数の説明
    /// @return 戻り値の説明
    int methodPublic(int p) {
        return p;
    }
};

/// @file

/// @brief 構造体の概要
/// @details 構造体の詳細
struct MyStruct {
    int member_1;  ///< メンバ１の概要
    int member_2;  ///< メンバ２の概要
};

/// @file

/// @brief 共用体の概要
/// @details 共用体の詳細
union MyUnion {
    char c;  ///< メンバ (char型) の概要
    int i;   ///< メンバ (int型) の概要
};