Doxygen有哪些注释标记符
时间: 2024-01-29 18:04:02 浏览: 129
Doxygen中常用的注释标记符有:
1. /**:表示一个块注释的开始,一般用于函数、类、结构体等开头的注释。
2. ///:表示单行注释,一般用于变量、函数参数、返回值等注释。
3. \brief:用于简要描述一个函数、变量、类等的作用。
4. \param:用于描述函数的参数,包括参数名、参数类型、参数说明等。
5. \return:用于描述函数的返回值,包括返回值类型、返回值说明等。
6. \author:用于描述代码的作者信息。
7. \date:用于描述代码的创建时间、修改时间等。
8. \version:用于描述代码的版本信息。
9. \note:用于添加一些额外的注释说明,比如函数的实现细节、注意事项等。
10. \warning:用于描述代码中的警告信息。
11. \todo:用于标记代码中需要完成的任务。
12. \endcode:用于表示一个代码块的结束。
相关问题
Doxygen所有标记符及作用
1. @file: 指定当前注释所在的文件名;
2. @brief: 对当前注释进行简要说明;
3. @details: 对当前注释进行详细说明;
4. @param: 对函数参数进行说明;
5. @return: 对函数返回值进行说明;
6. @throw: 对函数可能抛出的异常进行说明;
7. @exception: 对函数可能抛出的异常进行说明;
8. @warning: 对可能发生的警告进行说明;
9. @note: 对需要注意的事项进行说明;
10. @todo: 对需要完成的任务进行说明;
11. @deprecated: 对已经废弃的内容进行说明;
12. @since: 指定从哪个版本开始引入该注释的功能;
13. @version: 指定当前注释所在版本号;
14. @defgroup: 对一组相关的函数或者变量进行分组;
15. @addtogroup: 对一组相关的函数或者变量进行添加;
16. @ingroup: 将当前注释添加到某个分组中;
17. @name: 给当前注释设置一个名称;
18. @namespace: 对命名空间进行说明;
19. @class: 对类进行说明;
20. @struct: 对结构体进行说明;
21. @union: 对联合进行说明;
22. @enum: 对枚举类型进行说明;
23. @typedef: 对自定义类型进行说明;
24. @var: 对变量进行说明;
25. @property: 对属性进行说明;
26. @fn: 对函数进行说明;
27. @exception: 对异常进行说明;
28. @overload: 对重载函数进行说明;
29. @param[in]: 对输入参数进行说明;
30. @param[out]: 对输出参数进行说明;
31. @param[in,out]: 对输入输出参数进行说明;
32. @tparam: 对模板参数进行说明;
33. @classdesc: 对类的描述进行说明;
34. @headerfile: 指定头文件名;
35. @example: 给出示例;
36. @sa: 对相关内容进行引用;
37. @copybrief: 将 brief 信息复制到当前注释中;
38. @copydetails: 将 details 信息复制到当前注释中;
39. @copydoc: 将指定函数的注释复制到当前注释中。
阅读全文