第三章:PCL基础3.1
架构师为了确保在PCL中所有代码风格的一致性,使得其他开发者及用户容易理解源码,PCL开发者制定并遵循着一套严格的编写规范,PCL的开发者都默认此规范。
3.1PCL推荐的命名规范
1、文件命名
1)所有的文件名单词之间应该用下划线隔开,如:unordered_map.cpp
2)头文件的扩展名为.h
3)模板类实现文件的扩展名是.hpp
4)源文件的扩展名是.cpp
2、目录命名
所有的目录及其子目录命名应该符合,如果由多个单词组成,其之间用下划线隔开,PCL中各个目录遵循以下规则:
1)头文件都应该放在源码目录树种的include/下。
2)模板类实现文件都应放在目录树中的include/impl/下。
3)源文件都应该放在目录树中的src/下。
3、include语句
当文件在同一目录下时include指示语句用双引号,在其他情况下则用尖括号。例如:
#include<pcl/module_name/file_name.h>
#include<pcl/module_name/impl/file_name.hpp>
#include"file_name.cpp"//在同一目录下
4、宏定义命令
宏定义中字母都采用大写格式,为头文件所定义的宏最后面还需要加上下划线,并且名称从include下目录开始,例如pcl/filters/bilateral.h对应PCL_FILTERS_BILATERAL_H_。#ifndef和#define定义放在BSD协议后面代码前面,#endif定义一直在文件结尾,并且加上一句注释掉的宏对应头文件的宏定义,例如
//the BSD license
#ifndef PCL_MODULE_NAME_IMPL_FILE_NAME_HPP_//为避免重复包含头文件而定义的宏
#define PCL_MODULE_NAME_IMPL_FILE_NAME_HPP_
//the code
#endif //PCL_MODULE_NAME_IMPL_FILE_NAME_HPP_
5、命名空间命名
命名空间多于一个单词的,单词之间应该用下划线连接,例如:
namespace pcl_io
{
...
}
6、类/结构命名
类名(和其他自定义类型的名称)应该是CamelCased(驼峰命名)命名规范,也就是连写单词组成命名,每个单词首字母大写。但是也有例外,如果类名包含一个缩写,这个缩写应该全部大写,类名和结构名最好是名词组成的名字。例如PFHEstimation代替了EstimatePFH,下面是正确的例子:
class ExampleClass;
class PFHEstimation;
7、函数/成员函数命名
他们的命名应该采用camelCased,也就是连写单词组成命名,除了首个单词字母小写其他单词首字母大写,他们的参数命名单词之间用下划线隔开,函数和类的成员函数命名最好采用动词,应该确保这些名字能清楚表达函数或成员函数的功能,例如:checkForErrors()而不是errorCheck(),dumpDataToFile()而不是dataFiledump();正确的用法:
int applyExample(int example_arg);
8、变量命名
变量的命名应该单词之间用下划线隔开例如:
int my_variable;
1)迭代子变量命名。迭代子变量应该反应出他们迭代的对象,例如:
std::list<int> pid_list;
std::list<int>::iterator pid_it;//指示迭代的对象为点的索引
2)常量命名。常量的名字应该是全大写,例如:
const static int MY_CONSTANT=1000;
3)成员变量命名。类的成员变量命名单词之间用下划线隔开并且以下划线结尾,例如:
int example_int_;//对阅读PCL源码很有帮助,可明显区分成员变量和局部变量
9)Return语句
return语句需要在圆括号中设有返回值,即规定return语句必须有返回值,大家知道,return没有返回值也会编译,例如:
int main()
{
return(0);
}
3.1.2 PCL推荐的缩进与格式
在PCL中每个代码块的标准缩进是两个空格,在任何情况下可以用制表符或其他空格间隔的方式进行格式化代码,PCL利用多样化的GNU类型格式。
1、命名空间缩进格式
在头文件里,命名空间的内容应该缩进两个空格,例如:
在一个实现文件里,对每一个类成员函数或函数的命名必须添加命名空间限定,例如:
void pcl::Foo::bar()
{
}
2、类格式
一个模板类的模板参数必须与类定义在不同行,如:
template<typename T>
class Foo
{
...
}
3、函数/类成员函数格式
每一个函数的返回类型声明必须与函数声明放在不同行,例如:
void
bar();
在函数实现的时候也一样,返回类型必须与函数声明放在不同行,例如:
或者
或者
4、花括号
它必须成对出现,与上一句代码另起一行定义,必须闭合才组成合理的程序块。
5、空格格式
如果在头文件内嵌套应用了命名空间名,需要将其缩进两个空格,如:
类和结构成员采用两个空格进行缩进,访问权限限定(public、private、protected)与类成员一级,而在其限定下的成员则需要缩进两个空格,如
6、自动格式化代码
3.1.3设计结构
1、类和应用程序接口
2、参数传递
第三章:PCL基础3.1的更多相关文章
- CentOS 7.4 初次手记:第三章 CentOS基础了解
第三章 CentOS基础了解... 36 第一节 语言编码.终端... 36 I 查看语言编码... 36 II Tty?.pts/?. 36 第二节 bash/sh command. 38 I 查找 ...
- Struts2框架学习第三章——Struts2基础
本章要点 — Struts 1框架的基本知识 — 使用Struts 1框架开发Web应用 — WebWork框架的基本知识 — 使用WebWork框架开发Web应用 — 在Eclipse中整合To ...
- Intel汇编语言程序设计学习-第三章 汇编语言基础-上
汇编语言基础 3.1 汇编语言的基本元素 有人说汇编难,有人说汇编简单,我个人不做评价,下面是一个简单的实例(部分代码): main PROC mov eax,5 ;5送EAX寄存器 add ...
- 《Java从入门到失业》第三章:基础语法及基本程序结构(四):基本数据类型(字符编码和char型)
3.6.4字符编码 咦?怎么好像有东西乱入了?不是讲基本数据类型么?哈哈,因为还剩下最后一个char型了,因为char型会牵涉到Unicode编码相关,因此我决定先科普一下字符集编码. 我儿子现在上小 ...
- Intel汇编语言程序设计学习-第三章 汇编语言基础-下
3.4 定义数据 3.4.1 内部数据类型 MASM定义了多种内部数据类型,每种数据类型都描述了该模型的变量和表达式的取值集合.数据类型的基本特征是以数据位的数目量的大小:8,16,32,,48, ...
- 0003-20180422-自动化第三章-python基础学习笔记
3章 内容回顾: 1. 计算机组成 2. 程序编译器 3. 变量 4. 条件 5. 循环 6. py2与py3区别 - 默认编码, - 除法, - input ,raw_input 7. 位,字节关系 ...
- 第三章 - SQL基础及元数据获取
SQL的介绍 SQL的定义:结构化查询语句 SQL的作用:对库和表进行操作 SQL的常用分类 DDL 数据定义语言(Data Definition Language) DCL 数据控制语言(Data ...
- 《Python核心编程》 第三章 Python基础 - 练习
创建文件: # -*- coding: gbk -*- #! /auto/ERP/python_core/chapter ''' Created on 2014年5月21日 @author: user ...
- React开发实时聊天招聘工具 -第三章 React基础知识回顾
function a (props) { return <h1>hello world{this.props.asd}</h1> } class a extends React ...
- Intel汇编语言程序设计学习-第三章 汇编语言基础-中
3.2 例子:整数相加减 现在来看一个进行整数加减操作的汇编语言小程序.寄存器用于存放中间数据,我们调用一个库函数在屏幕上显示寄存器的内容.下面是程序的源码: TITLE Add and Subtr ...
随机推荐
- 字符集、字符编码、XML中的中文编码
字符集.字符编码.XML中的中文编码 作为程序员的你是不是对于ASCII .UNICODE.GB2321.UTF-7.UTF-8等等不时出现在你面前的这些有着奇怪意义的词感到很讨厌呢,是不是总觉得好象 ...
- 在asp.net中使JQuery的Ajax用总结
自从有了JQuery,Ajax的使用变的越来越方便了,但是使用中还是会或多或少的出现一些让人短时间内痛苦的问题.本文暂时总结一些在使用JQuery Ajax中应该注意的问题,如有不恰当或者不完善的地方 ...
- [转]angular的路由机制
在谈路由机制前有必要先提一下现在比较流行的单页面应用,就是所谓的single page APP.为了实现无刷新的视图切换,我们通常会用ajax请求从后台取数据,然后套上HTML模板渲染在页面上,然而a ...
- 前用户sudo免密码
Ubuntu 设置当前用户sudo免密码 方法1 # 备份 /etc/sudoers sudo cp /etc/sudoers . #打开 /etc/sudoers sudo visudo # 在 ...
- 通过Azure File Service搭建基于iscsi的共享盘
在Azure上目前已经有基于Samba协议的共享存储了. 但目前在Azure上,还不能把Disk作为共享盘.而在实际的应用部署中,共享盘是做集群的重要组件之一.比如仲裁盘.Shared Disk等. ...
- 配置进程外Session
配置进程外Session: (1)将服务器Session信息存储在进程外 <1> 首先,开启asp.net state 服务: 控制面板 -> 程序和功能 -&g ...
- (转)NHibernate之Generator主键生成方式
本文转载自:http://www.cnblogs.com/lemon-love/archive/2010/03/10/1683058.html (1) assigned主键由外部程序负责生成,无需NH ...
- 第15届浙江省赛 D Sequence Swapping(dp)
Sequence Swapping Time Limit: 1 Second Memory Limit: 65536 KB BaoBao has just found a strange s ...
- 杂项:DCloud.io
ylbtech-杂项:DCloud.io 1.返回顶部 1. DCloud.io,数字天堂(北京)网络技术有限公司. 国内HTML5产业的领军企业,W3C会员,HTML5中国产业联盟发起单位Dclou ...
- python第三十二天-----算法
算法(Algorithm):一个计算过程,解决问题的方法时间复杂度:用来评估算法运行效率的一个东西ps:在日常使用中,请使用sort(),because no zuo no die! 1.冒泡排序:指 ...