1 首先按照Doxygen的规范注释代码
具体可以选择一种样例
2 在注释代码的基础上,生成Doxygen html注释文档
- 比方我想对Perception/libs 目录底下的 roi segment tracking等文件生成注释文档
那么我就在libs这一级目录下:
doxygen -s -g
// 注释:上述s 和 g 分别表示simple和generate
此时会生成一个Doxyfile
再对Doxyfile里面进行配置修改,主要是yes no的关于输出文件的配置
- 使用命令输出
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