Doxygen常用标签命令关键字

1. 文件信息:
  1) @file       --> 文件声明,即当前文件名
  2) @author  --> 作者
  3) @version --> 版本,推荐使用$Id$
  4) @todo     --> 改进,可以指定针对的版本

2. 模块信息:
  1) @var        --> 模块变量说明
  2) @typedef --> 模块变量类型说明

3. 函数信息:
  1) @param  --> 参数说明
  2) @arg       --> 列表说明参数信息
  3) @return   --> 返回值说明
  4) @retval    --> 返回值类型说明
  5) @note      --> 注解

4. 提醒信息:
  1) @brief         --> 摘要,即当前文件说明
  2) @see           --> 参看
  3) @attention  --> 注意
  4) @bug          --> 问题
  5) @warning   --> 警告
  6) @sa             --> 参考资料

你可能感兴趣的:(Doxygen常用标签命令关键字)