doxygen函数注释规范

Doxygen是一种广泛使用的开源文档生成工具，它主要用于从源代码中提取注释并自动生成API参考文档。对于Doxygen来说，有一个推荐的函数注释规范，称为"Q-todo风格"或者"Javadoc风格"：

1. **函数声明**：

   /**
   * \brief 函数简短描述
   *
   * 更详细的函数说明，可以包括输入、输出参数以及功能用途。
   * \param[in] param1 参数一的描述
   * \param[out] param2 参数二的描述
   * \return 返回值的描述，如果无返回值则省略此部分
   */
   void functionName(param1_type param1, param2_type param2);

2. **成员变量**：

   /**
   * \brief 变量名的描述
   * \sa 紧密相关的函数或变量
   */
   variable_name type;

3. **类或结构体**：

   /**
   * \class ClassName 类的详细描述
   * \brief 简短的类描述
   */
   class ClassName {
      // 成员和方法...
   };