doxygen的使用心得

1. 文件头的注释：

/*************************
  * @brief  描述              *
  * *
  * @auther 作者 *
  ***********************/

2.代码行尾及枚举类型和结构体类型的注释：

///< 代码注释

3.函数及结构体前的注释：

/**
  *  描述
  */

4.函数的注释：

 /**
      * @brief  描述.
      *
      * @param  参数
     *
      * @return
      *     返回值
      */