PCL推荐的命名规范(2)
博客转载自:http://www.pclcn.org/study/shownews.php?lang=cn&id=210
函数/成员函数命名
函数和类的成员函数的命名应该采用camelCased,也就是连写单词组成命名,除了首个单词首字母小写其他单词首字母大写,它们的参数命名单词之间用下划线隔开,函数和类的成员函数命名最好采用动词,应该确保这些名字能清楚的表达函数和类成员函数的功能,例如:checkForErrors()而不是errorCheck(), dumpDataToFile()而不是dataFiledump(),正确的用法:
int applyExample (int example_arg);
变量命名
变量的命名应该单词之间用下划线隔开例如:
int my_variable;
a.迭代子变量命名
迭代子变量应该反应出它们迭代的对象,例如:
std::list<int> pid_list; std::list<int>::iterator pid_it;//指示迭代的对象为点的索引
b.常量命名
常量的名字应该是全大写,例如:
const static int MY_CONSTANT =1000;
c.成员变量命名
类的成员变量命名单词之间用下划线隔开并且以下划线结尾,例如:
int example_int_;//对阅读PCL源码很有帮助,可明显区分成员变量与局部变量
Return语句
return语句需要在圆括号有返回值,即规定return语句必须有返回值,大家知道,return如果没有返回值也会编译,例如:
int main () { return (0); }
敬请关注PCL(Point Cloud Learning)中国更多的点云库PCL(Point Cloud Library)相关官方教程。
参考文献:
1.朱德海、郭浩、苏伟.点云库PCL学习教程(ISBN 978-7-5124-0954-5)北京航空航天出版社2012-10