Doxygen生成代码注释文档

1 首先按照Doxygen的规范注释代码

具体可以选择一种样例

2 在注释代码的基础上,生成Doxygen html注释文档

  1. 比方我想对Perception/libs 目录底下的 roi segment tracking等文件生成注释文档
    那么我就在libs这一级目录下:
doxygen -s -g
// 注释:上述s 和 g 分别表示simple和generate

此时会生成一个Doxyfile
在这里插入图片描述
再对Doxyfile里面进行配置修改,主要是yes no的关于输出文件的配置

  1. 使用命令输出
doxygen Doxyfile

3 VScode注释Doxygen风格

注释风格参考:
https://blog.youkuaiyun.com/stelalala/article/details/9376187
注释插件参考:
Generate Doxygen Comments 插件使用及配置
https://blog.youkuaiyun.com/wang0huan/article/details/103107472

参考文档:
https://blog.youkuaiyun.com/AlexBein/article/details/100163012

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值