Contents

ROS:ROS代码命名规范

Contents

本文采用知识共享署名 4.0 国际许可协议进行许可,转载时请注明原文链接,图片在使用时请保留全部内容,可适当缩放并在引用处附上图片所在的文章链接。

范例 命名规范名称 规则 应用场景 示例
CamelCased 大驼峰 (匈牙利命名法) 首字母大写,其后每个单词首字母大写 用于表示类名、类型。 class ExampleClass;(类名) class HokuyoURGLaser;(带缩写单词的类名,缩写字母 URG 全大写)
camelCased 小驼峰 (匈牙利命名法) 首字母小写,之后单词首字母大写 方法、函数名 int exampleMethod(int example_arg);
under_scored 小写 + 下划线 名称仅使用小写字母,单词之间用下划线分隔。 ROS packages 名称Topics 名Services 名文件名 (.cpp、.c、.h); 库名 (注意格式是 libxxx_yyy, 而不是 lib_xxx_yyy) ; 命名空间 ros_openvino_toolkit(功能包名) action_server.h(文件名) libmy_great_thing(库名) std::list<int> pid_list; (变量名) int example_int_; (成员变量以下划线**_结尾**) int g_shutdown; (全局变量以**g_开头**)
ALL_CAPITALS 全部大写 全部字母大写,单词之间用下划线分隔。 常量 PI
__XXXX 前置下划线 前置下划线(__),在命名中不要使用前置下划线 系统保留 __builtin_expect (一般开发者不需要修改这方面内容)

类名、类型 使用大驼峰 (匈牙利命名法) 示例:class CamelCased

方法、函数名 使用 小驼峰 (匈牙利命名法) , 函数参数使用小写加下划线 示例:int funCall(int example_arg)

类成员变量使用 m 开头 如 int m_example_arg