码迷,mamicode.com
首页 > 其他好文 > 详细

代码备忘录--常用的一些Doxygen格式

时间:2019-12-03 23:50:11      阅读:170      评论:0      收藏:0      [点我收藏+]

标签:***   line   strong   @param   file   return   pre   文件头   val   

1.文件头的格式:

/**
****************************************************************************
* @file xxx.cpp
* @author xxx
* @version V 1.0.0
* @date 15-10-2019
* @brief xxx
****************************************************************************
*/

2.函数的注释:

/**
*******************************************************************************
*
* @brief  xxx
* @brief  xxx
* @param [xx] xxx
* @return xxx
* @retval [FunctionResult::SUCCESS] xx fail
* @retval [FunctionResult::SUCCESS] xx success
*
*******************************************************************************
*/

3.定义变量时的注释(放到变量那行的末尾):

/**< xxx */

  

代码备忘录--常用的一些Doxygen格式

标签:***   line   strong   @param   file   return   pre   文件头   val   

原文地址:https://www.cnblogs.com/snowsad/p/11980096.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!