006_limou_2024_05_10_文档库
约 730 字大约 2 分钟
2025-04-09
1.1.查看源代码
【AXin带你学Doxygen 生成文档超简单！】https://www.bilibili.com/video/BV1ZE411F7kW?p=6&vd_source=4772b64d7a3cb1873f14bc0153c4de68
1.2.使用源代码
/*!
* @file
* @brief 文件的简要描述
* 文件的详细描述.
* @author 作者
* @date yyyy-mm-dd
* @version 版本号
* @link 链接 @endlink
*/
/**
* @namespace MyPoj
* @brief 命名空间的简要描述
* 命名空间的详细描述.
*/
namespace MyPoj {
/**
* @def MY_MACRO
* @brief 宏的简要描述
* 宏的详细描述.
*/
#define MY_MACRO(x) (x * x)
/**
* @brief 类外函数的简要描述
* 类外函数的详细描述
*
* @param[in] arg1 的简要描述
* @param[out] arg2 的简要描述
* @return 返回值的简要描述
* @retval 返回值说明
*
* @pre 函数使用前的前置条件
* @post 函数使用后的后置条件
*
* @note 函数的注意事项.
* @warning 函数的警告事项.
* @throw 抛出异常 的简要描述.
* @see 指示读者查看其他相关的单个条目.
* @sa 指示读者查看其他相关的多条条目.
*
* @example
* 函数的演示说明.
* @code{.cpp}
* 具体的缩进的代码块
* @endcode
*/
void globalFunction(int arg1, int arg2) {
// 函数实现
}
/**
* @class Test
* @brief 类的简要描述
* 类的详细描述.
*/
class Test {
public:
/**
* @enum TEnum
* @brief 枚举的简要描述
* 枚举的详细描述.
*/
enum TEnum {
TVal1, ///< 枚举成员的简要描述.
TVal2, ///< 枚举成员的简要描述.
TVal3 ///< 枚举成员的简要描述.
}
*enumPtr, ///< 枚举指针变量的简要描述.
enumVar; ///< 枚举变量的简要描述.
/**
* @brief 构造函数的简要描述
* 构造函数的详细描述.
* ...
*/
Test();
/**
* @brief 析构函数的简要描述
* 析构函数的详细描述.
* ...
*/
~Test();
/**
* @brief 成员函数的简要描述
* 成员函数的详细描述.
*
* @param[in/out] arg1 的简要描述.
* @param[in/out] arg2 的简要描述.
* @return 函数的返回值.
* @retval 返回值说明(例如真假).
*
* @pre 函数使用前的前置条件
* @post 函数使用后的后置条件
*
* @note 函数的注意事项.
* @warning 函数的警告事项.
* @throw 抛出异常 的简要描述.
* @see 指示读者查看其他相关的单个条目(使用 func() 的形式即可).
* @sa 指示读者查看其他相关的多条条目(使用 func() 的形式即可).
*
* @example
* 函数的演示说明.
* @code{.cpp}
* 具体的缩进的代码块
* @endcode
*/
int testMe(int arg1, int arg2);
private:
int publicVar; ///< 成员变量的简要描述.
};
/**
* @using NewTypeName
* @brief 类型的简要描述
* 类型的详细描述.
*/
typedef OldTypeName NewTypeName;
/**
* @var myVar
* @brief 变量的简要描述
* 变量的详细描述.
*/
int myVar;
}更新日志
2025/11/24 07:31
查看所有更新日志