注释Carla的 LibCarla 、CarlaUE4 模块,包括实现方式、实现原理、流程图等。做出贡献之前请查看 指南 。
1.下载并安装git 、doxygen ,可选软件:GitTortoiseGit 、VS2019社区版;
2.克隆仓库:
git clone https://github.com/OpenHUTB/carla_cpp.git
3.在项目主目录下运行以下命令,根据 C++ 代码生成对应的 html 文档:
doxygen
进入carla_cpp\Doxygen\html
目录下,双击或使用浏览器打开dir_b14cdd661f9a7048a44f1771cd402401.html
、dir_8fc34afb5f07a67966c78bf5319f94ae.html
或index.html
查看修改后的效果。包括的文档:
-
LibCarla/source/carla:Doxygen/html/dir_b14cdd661f9a7048a44f1771cd402401.html
-
CarlaUE4:Doxygen/html/dir_8fc34afb5f07a67966c78bf5319f94ae.html
4.修改并本地测试没问题后,提交代码:
git add .
git commit -m update
git push
详细注释方法参见注释规范 。
直接创建一个空白的分支,而是像普通的分支一样把原分支的内容拷贝过来:
git checkout --orphan dev
还需要手动删除孤立分支中的内容:
git rm -rf .
nongfugengxia 、donghaiwang 、 QEYY060506 、Xiedao 、zzz479 、ifthen865 、zuo664、Allen-Tang0014、BcyWind 、 Nananxuan。