1. 安装Ubuntu
略。
2. 安装并配置ROS环境
略。
3. 开发工程的建立与项目管理
4. PCL编码风格简介
- PCL编程规范
- PCL推荐的命名规范
- 文件命名:
- 所有的文件名单词之间应该用下划线隔开,例如 unordered_map.hpp。
- 头文件的拓展名为.h。
- 模板类实现文件的扩展名为.hpp。
- 源文件的扩展名为.cpp。
- 所有的文件名单词之间应该用下划线隔开,例如 unordered_map.hpp。
- 文件命名:
- PCL推荐的命名规范
2. 目录命名
1.所有的目录及其子目录命名时,如果由多个单词组成,其之间用下划线隔开。
1.头文件都应该放在源码目录树中的include/下。
2.模板类实现文件都应该放在目录树中的include/impl/下。
3.源文件都应该放在目录树中的src下。
3. include语句
1.当文件在同一目录下时include指示语句用双引号,在其他情况下则用尖括号。
1.#include <pcl/module_name/file_name.h>
2.#include <pcl/module_name/impl/file_name.hpp>
3.include "file_name.cpp"
4. 宏定义命名
1.宏定义中都采用大写字母,为头文件所定义的宏,最后面还要加上下划线,并且名称从include下目录开始,例如pcl/filters/bilateral.h对应PCL_FILTERS_BILATERAL_H_。#ifndef和#define定义放在BSD后面,代码前面。#endif定义一直在文件结尾,并且加上一句注释掉的宏对应头文件的宏定义。
//the BSD license
#ifndef PCL_MODULE_NAME_IMPL_FILE_NAME_HPP_ //为避免重复包含头文件而定义的宏
#def PCL_MODULE_NAME_IMPL_FILE_NAME_HPP_
//the code
#endif //PCL_MODULE_NAME_IMPL_FILE_NAME_HPP_
5. 命名空间的命名
1.命名空间多于一个单词的,用下划线隔开
namespace pcl_io
{
...
}
6. 类/结构命名
1.类名、结构名遵循驼峰命名规则,最好是名词构成的名字。此外,如果包含缩写则缩写应该全部大写。
class ExampleClass;
class PFHEstimation;
7. 函数/成员函数命名
1.函数/成员函数命名也遵循驼峰命名规则,除开首个字母小写。函数/成员函数的参数命名单词全部用小写而且名词之间用下划线隔开。同时函数名/成员函数名最好用动宾结构以便于能清楚地表达函数的功能。
int applyExample(int example_arg);
8. 变量命名
1.命名变量时,单词之间应该用下划线隔开。
int my_variable;
2.迭代子变量命名应该能反映出它们的迭代对象。
std::list <int> pid_list;
std::list <int> ::iterator pid_it;
3. 常量命名,应该全是大写。
const static int MY_CONSTANT = 1000;
4. 成员变量命名,单词之间用下划线隔开并以下划线结尾。
int example_int_;
9. return语句
return语句要在圆括号内有返回值,即规定return语句必须有返回值。
int main()
{
return (0);
}
2. PCL推荐的缩进与格式
1. 命名空间缩进格式
2. 类格式,一个模板类的模板参数必须与类定义在不同行。
3. 函数/类成员函数格式
4. 花括号
5. 空格格式