Skip to content

GODCharles/carla_cpp

 
 

Repository files navigation

Carla 的 C++ 文档

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

生成文档

1.下载并安装gitdoxygen ,可选软件:GitTortoiseGit 、VS2019社区版;

2.克隆仓库:

git clone https://github.com/OpenHUTB/carla_cpp.git

3.在项目主目录下运行以下命令,根据 C++ 代码生成对应的 html 文档:

doxygen

进入carla_cpp\Doxygen\html目录下,双击或使用浏览器打开dir_b14cdd661f9a7048a44f1771cd402401.htmldir_8fc34afb5f07a67966c78bf5319f94ae.htmlindex.html查看修改后的效果。包括的文档:

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

git add .
git commit -m update
git push

修改方法

修改类的注释

1.比如对于UOpenDriveMap,修改之前:

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

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

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

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

新建开发分支

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

git checkout --orphan dev

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

git rm -rf .

参考

贡献者列表

nongfugengxiadonghaiwangQEYY060506Xiedaozzz479ifthen865zuo664Allen-Tang0014BcyWindNananxuan

Releases

No releases published

Packages

No packages published

Languages

  • C++ 92.8%
  • C 5.9%
  • Other 1.3%