编码指南

警告

正在施工中

通用准则

现在,请参阅以下链接：

• https://docs.ros.org/en/humble/Contributing/Developer-Guide.html

此外,请记住以下概念.

• 保持一致.
• 尽可能自动化,使用简单的格式、语法等检查.
• 用英语撰写评论和文档.
• 过于复杂(低内聚)的函数应适当地拆分为较小的函数(例如,在 google style guideline 中建议一个函数少于 40 行).
• 尽量减少使用范围较大的成员变量或全局变量.
• 只要有可能,将大型拉取请求分解为更小的、可管理的 PR(在某些研究中建议少于 200 行更改,例如 here).
• 当涉及到代码审查时,不要在琐碎的分歧上花费太多时间.有关详细信息,请参阅：
  • https://en.wikipedia.org/wiki/Law_of_triviality
  • https://steemit.com/programming/@emrebeyler/code-reviews-and-parkinson-s-law-of-triviality
• 请遵循每种语言的指南.
  • C++
  • Python
  • Shell 脚本

Autoware 风格指南

有关特定于 Autoware 的样式,请参阅以下内容：

• 对软件包名称使用 autoware_ 前缀.
  • 参见 Directory structure guideline, Package name
  • 参见 Prefix packages with autoware_
• 在 autoware 命名空间中添加实现.
  • 参见 类设计指南,命名空间
  • 参见 Prefix packages with autoware_, Option 3：
• 要导出的头文件必须放在 PACKAGE_NAME/include/autoware/ 目录中.
  • 参见 目录结构指南,导出标头
• 在 CMakeLists.txt 中,使用 autoware_package().
  • 参见 autoware_cmake README