Skip to content

OpenHUTB/carla_cpp

Repository files navigation

Carla 的 C++ 文档

注释Carla的 LibCarlaCarlaUE4 模块,包括实现方式、实现原理、流程图等。做出贡献之前请查看 指南

生成文档

1.打开 github 注册并登录,然后下载安装gitdoxygen ,可选软件:GitTortoiseGitVS2019社区版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.htmldir_8fc34afb5f07a67966c78bf5319f94ae.htmlindex.html,HTML仅仅用于查看,不需要提交,需要修改和提交的是.cpp和.h文件。包括的文档:

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重新生成文档,查看修改后的文档:

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

参考

贡献者列表

nongfugengxiadonghaiwangQEYY060506Xiedaozzz479ifthen865zuo664Allen-Tang0014BcyWindNananxuanxiazhimingchenMuyunshuiWen-511juanexuanjun-72xiushuowanggongguixuanHyz12345678M-3399Candela-bestkarry-tangwenli-xiongwwwwu1207leixing1IHateTheWorld-ZhouMamba321857gyqssliujue0yyyyy1026sematic9527yuxiyu666xjc548Yuuydzzreo141271zxy-125fx-hjA-0-A-0-Axuuu-1minghao-leeLhb10652HerzeHuBigmouselujianjjjjchen-18smile947cm1106-aipengwenzhuo6789waaRinco520yanpeng0902zxxzyyhuangjj114fengchuanyincby2838Ekisanhinnyyyyy12306lzh8215Rita0621zxy953MengruChen0723lwwwwwwwww9bobo339hannah-oyeyskthalochenzhentao-chenjiangyaqin6zhouxiayu698feng569150Dipmilli-guanhuayangh05tushuguanL18692223518tellwhatMikecbkZLW523523ovsehunlyj510YPPBTCmjyy22DanandVVayuanshen6666666nfdxxlKawashiro1DSB0221huangyukingZH1024-Hengsiwei1427huangzhihuahuiii-chenxhoyhggiiatrsuki-minaqqggxxleeyuu-zzi666zidzq168riset77ylyl551zhemuqiYL007-STRONGnigor-peterjiameixiao2665055983Seavey0402yangf95LBQ0056yuangjiajieweidinghexinderruilaYJY336Zeng-Qi37hyjrikyhvv313lwh0954csgo3553Mia-cloud-delhui215151SRX-ytkxiaoyu-903zhouxinyu-a11ywdlmd20wdlmd20Hcir-lkS1TZlzg6667RYZ-666TaohyggeHZY-23hugufy54zwzxuebaobizuicertain-mkuanghy123longxiang06takagisdq1xiao-ice666bless416haleelyhaohaozhuzzzzbig-ShuaigelingyanNBLzQnfangao-is-not-fangaohexincankinggsazhengyuyan1qianyouyou007hjt468zzzzadxsLLLhutbysz288Amuamu77zhong246mikilejZz1tai77Dennnng123 Rrr7702 longakijushuaiyaxianwang7 dengyanyan1 Blessingwish 1722698697 sx2005 266762548awa Peng-185 ysthhhhylsj666wyy124 2209040022llmoon884haoCui-hutb caicaiyo 2899661520 ALKAID540 kifiliketomato Platycodon7 Yule-eeeeee lu-jiahui 28996615201 maokeyi qingchucheng tw-tw1215 zkrspec tangruixin170 EvilBatman Tcowl darkrose509 susu0201 leejay2005 xuweier 15773272552 ashudou vllcf wyy124 wenzheng236 qingyun-cmyk Sword761 xiaochenop chaojixiangshuijiao liiiiiking Yygo100 1351964418hml xiejinkun0625 676sdaw

About

No description, website, or topics provided.

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 230