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插件后,输入/**回车,能自动生成注释模板,非常方便。

 

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值