doxygen 大纲注释写到头文件,详细注释写到源文件

doxygen 大纲注释写到头文件,详细注释写到源文件

doxygen 大纲注释写到头文件,详细注释写到源文件

Unlike most other documentation systems, Doxygen also allows you to put the documentation of members (including global functions) in front of the definition. This way the documentation can be placed in the source file instead of the header file. This keeps the header file compact, and allows the implementer of the members more direct access to the documentation. As a compromise the brief description could be placed before the declaration and the detailed description before the member definition.

虽然文档里这么说,但是如果按照文档里说的写注释,VC++ 2022 的代码提示里,只会包含 @brief 注释;如果把所有内容写在头文件里,那么 VC++ 2022 的代码提示里会包含除了返回值以外的所有的注释文字。

参考网址: https://www.doxygen.nl/manual/docblocks.html#cppblock

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值