OpenHUTB/carla_cpp - Githubissues

# Carla 的 C++ 文档注释Carla的 LibCarla 、CarlaUE4 模块，包括实现方式、实现原理、流程图等。做出贡献之前请查看指南。

生成文档

1.下载并安装git 、doxygen ，可选软件：GitTortoiseGit 、VS2019社区版、Watt Toolkit免费加速器；

2.在湖工商仓库页面点击Fork，然后点击Create a new fork，创建分叉到个人仓库。

3.克隆个人仓库（若出现SSL certificate problems请关闭加速器再克隆）：

git clone https://github.com/{username}/carla_cpp.git

4.添加C++代码注释（编码标准），如果需要查看生成的文档，在项目主目录下运行以下命令，根据 C++ 代码生成对应的 html 文档：

doxygen

进入carla_cpp\Doxygen\html目录下，双击或使用浏览器打开dir_b14cdd661f9a7048a44f1771cd402401.html、dir_8fc34afb5f07a67966c78bf5319f94ae.html或index.html，HTML仅仅用于查看，不需要提交，需要修改和提交的是.cpp和.h文件。包括的文档：

LibCarla/source/carla：Doxygen/html/dir_b14cdd661f9a7048a44f1771cd402401.html
CarlaUE4：Doxygen/html/dir_8fc34afb5f07a67966c78bf5319f94ae.html

5.修改并本地测试没问题后，提交代码到个人仓库：

git add README.md
git commit -m "update"
git push

6.在自己仓库的首页发现有提交领先于湖工商仓库的dev分支，则点击Contribute创建Pull Request，来湖工商仓库做出贡献，创建成功后等待管理员审核通过（如果发现个人仓库落后于湖工商仓库则点击Sync frok以同步其他人的最新修改）。

修改方法

修改类的注释

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

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

3.翻译代码中的注释或添加新注释（注意：翻译后，原来的英文注释不需要保留。源代码文件统一采用UTF-8-BOM编码，即UTF-8带签名编码，vs2019中的操作方法）：

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

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

参考

贡献者列表

nongfugengxia 、donghaiwang 、 QEYY060506 、Xiedao 、zzz479 、ifthen865 、zuo664 、Allen-Tang0014 、BcyWind 、 Nananxuan 、xiazhimingchen 、Muyunshui 、Wen-511 、juanexuan 、 jun-72 、 xiushuowang 、 gongguixuan 、 Hyz12345678 、 M-3399 、 Candela-best 、 karry-tang 、 wenli-xiong 、wwwwu1207 、 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 、yanpeng0902 、 zxxzyy 、 huangjj114 、 fengchuanyin 、 cby2838 、 Ekisanhinn 、 yyyyy12306 、 lzh8215 、 Rita0621 、 zxy953 、 MengruChen0723 、 lwwwwwwwww9 、 bobo339 、 hannah-oyeys 、 kthalo 、 chenzhentao-chen 、 jiangyaqin6 、 zhouxiayu698 、 feng569150 、 Dipmil 、 li-guanhua 、 yangh05 、 tushuguanL 、 18692223518 、 tellwhat 、 Mikecbk 、ZLW523523 、 ovsehun 、 lyj510 、 YPPBTC 、mjyy22 、 DanandVVa 、 yuanshen6666666 、 nfdxxl 、Kawashiro1、 DSB0221、huangyuking、 ZH1024-Heng、 siwei1427 、 huangzhihua 、 huiii-chen 、 xhoyh 、 ggiiatr 、 suki-mina 、 qqggxx、 leeyuu-z 、 zi666zi 、 dzq168、 riset77、 ylyl551、 zhemuqi、 YL007-STRONG、 nigor-peter、 jiameixiao、 2665055983、 Seavey0402、 yangf95、 LBQ0056、 yuangjiajie 、 weidinghe、 xinderruila、 YJY336、 Zeng-Qi37、hyjrilky、 vv313、 lwh0954、 csgo3553 、 Mia-cloud-del 、 hui215151、 SRX-ytk、 xiaoyu-903、 zhouxinyu-a11y、 wdlmd20、 wdlmd20、 Hcir-lk、 S1TZ、 lzg6667、 RYZ-666、 Taohygge、 HZY-23、 [hugufy](https://github.com/hugufy）、 54zwz、 xuebaobizui、 certain-m、 kuanghy123、 longxiang06、 takagis、 dq1、 xiao-ice666、 bless416、 haleely。 haohaozhuzzzz、 big-Shuaige、 lingyanNB、