Carla 的 C++ 文档

注释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，HTML仅仅用于查看，需要改的是.cpp文件并提交.cpp和.h文件。包括的文档：

• LibCarla/source/carla：Doxygen/html/dir_b14cdd661f9a7048a44f1771cd402401.html

• CarlaUE4：Doxygen/html/dir_8fc34afb5f07a67966c78bf5319f94ae.html

4.修改并本地测试没问题后，提交代码：

git add .
git commit -m update
git push

修改方法

修改类的注释

1.比如对于UOpenDriveMap，修改之前：

2.找到需要修改的文件：

3.翻译代码中的注释或添加新注释：

4.运行doxygen重新生成文档，查看修改后的文档：

详细注释方法参见注释规范 。

新建开发分支

直接创建一个空白的分支，而是像普通的分支一样把原分支的内容拷贝过来：

git checkout --orphan dev

还需要手动删除孤立分支中的内容：

git rm -rf .

参考

• Carla中文文档
• 从源代码构建 Carla
• 在 Windows 上进行 Carla 的调试
• dev分支提交历史
• 注释图片在文档里面查看

贡献者列表

nongfugengxia 、donghaiwang 、 QEYY060506 、Xiedao 、zzz479 、ifthen865 、zuo664、Allen-Tang0014、BcyWind 、 Nananxuan 、xiazhimingchen、Muyunshui、Wen-511、juanexuan jun-72 xiushuowang gongguixuanHyz12345678 M-3399 Candela-best karry-tang wenli-xiong leixing1 IHateTheWorld-Zhou Mamba321857 gyqss liujue0 yyyyy1026 sematic9527 yuxiyu666 xjc548 Yuuydz zreo141271、zxy-125、fx-hj A-0-A-0-A 。 xuuu-1 minghao-lee 。 Lhb106、 52Herze HuBigmouse lujianjjjj chen-18. smile947. cm1106-ai. pengwenzhuo6. 789waa Rinco520 zxxzyy huangjj114 fengchuanyin cby2838 Ekisanhinn Seavey0402 yyyyy12306、 lzh8215。 Rita0621