Doxygen 函数注释

一 demo

class FunctionDemo{
  public:
  /**
   * @brief func是一个普通成员函数
   * 
   * @param a [in] param a
   * @param b [in, out] param b
   * @param c [out] output
   * @return int 
   * @retval
   * 1 : result1； 
   * 2 : result2；
   * @see f()
   */
  int func(int a, int b, int c){}

/**
 * @brief func_t是一个成员模板函数
 * 
 * @tparam T 输入类型
 * @param a param a
 * @param t param t
 * @return int 返回值
 */
  template<typename T>
  int func_t(int a, T t){}

  int f(){}
};

效果：

二 辅助工具

我在VSCode中启用Doxygen DG插件后，输入/**回车，能自动生成注释模板，非常方便。