常用的Doxygen标签有哪些

2023年12月10日,周日上午


Doxygen 支持多种标签,用于在源代码中添加注释,以生成代码文档。

以下是一些常用的 Doxygen 标签:

  1. @brief: 提供简短的函数或类概要。

  2. @param: 用于描述函数的参数。例如,@param paramName 描述参数的作用

  3. @return: 用于描述函数的返回值。例如,@return 描述返回值的意义

  4. @see: 引用其他相关的函数、类或文档。例如,@see OtherFunction()

  5. @defgroup@addtogroup: 用于创建和组织模块或组。

  6. @file: 用于指定文件的描述。

  7. @class: 用于描述类,通常与 @brief 一起使用。

  8. @namespace: 用于描述命名空间。

  9. @warning: 用于标记警告信息。

  10. @deprecated: 用于标记已过时的函数或类。

  11. @todo: 用于标记待办事项。

  12. @code@endcode: 用于包裹一段代码块,使其在文档中呈现为代码。

  13. @example: 用于添加示例代码。

这只是一小部分 Doxygen 标签,实际上还有很多其他标签可用。使用这些标签可以帮助生成详细的代码文档,提高代码的可读性和可维护性。建议查阅 Doxygen 的官方文档以获取更全面的信息。

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

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

巨龙之路

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值