Doxygen注释的几种风格(for C-like languages)

一 Javadoc style

/**
 * @brief this is a javadoc style comment1.
 */
 
/**
 @brief this is a javadoc style comment2.
 */

/** @brief this is a javadoc style comment3.*/

 class JavaDocStyle{	 
 };

Javadoc风格最主要的特征是开始的两个*;单行多行均可,例如上面的comment1和commen3;中间的*可以省略,例如上面的comment2.

二 Qt style

/*!
 * @brief this is a Qt style comment.
 */

 class QtStyle{
 };

区别是两个*换成了*!。

三 third style

///
/// @brief this is a third style comment1.
///

//!
//! @brief this is a third style comment2.
//!

 class ThirdStyle{	 
 };

不同风格可以混合使用,但从清晰度考虑,不推荐。

四 html效果

五 参考

Doxygen风格

  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值