编码规范

原则,像读英文一样读代码。

变量命名规范

1.数据成员使用m_前缀,参数名小写。
2.类名首字母大写。
3.函数名首字母小写。
4.名称空间小写。
5.指针后缀使用Ptr,或者前缀p。
6.结构体后缀使用St。
7.编写自解释程序而不是使用注视。
8.模版类的声明和实现放在同一个.h文件中。
9.声明放在.h中,实现放在.cpp中,内联函数也要放在.cpp中。
10.不在源文件中使用extern。
11.typedef使用大写字母。
12.声明顺序,public,protected,private,friend。
13.避免使用值传递(效率低)。
14.使用默认参数而不是重载。
15.删除的指针要赋予空指针。
16.不要在循环体内定义对象。
17.使用+=、—=、>>=等复合运算符,而不是a=a+1。(减少临时对象)。
18.尽可能使用C++11的规范。
19.将要做和未完成的使用 TODO 标注。
20.全局变量使用g_前缀。
21.宏全部大写,单词间用分隔符_隔开。
22.枚举类型用能反应其基础类型、单数形式的前缀,例如:Color_Red,Color_Blue。
23.ifelse语句中一定要使用大括号。
24.已删除的对象指针要赋予空指针值。
25.使用默认参数而不是函数重载。
26.避免利用值传递对象。
27.判断返回值,考虑else。
28.关于运算顺序:同时有乘除运算时,要根据操作数的取值范围决定运算顺序,以防止溢出。
29.如果一个表达式是常量,一个表达式是变量,则常量做左操作数,变量做右操作数。这样即使少写一个等号,也会因为编译不能通过而发现。
30.关于sizeof:因为存在数据对齐,因此,结构体的size不总是其各个成员的size的和。定义结构体时,尽量把空间占用小的变量放在前面,相同类型的变量连续放置。
31.当有符号数与无符号数混合运算时,要进行强制类型转换,使二者类型相同。如果有符号数不会有负值则可以将有符号数转换为无符号数。如果无符号数不会大于有符号数的最大值则可以把无符号数转换为有符号数。否则,系统自行进行转换可能会有问题:将有符号数转换为无符号数,运算结果是有符号数还是无符号数取决于结果变量类型。

int i = -2。
	unsigned int j = 2。
	i = i/j。
i = 2147483647
因为:计算i/j时,系统把-2转换为无符号数(值很大),除以j后,符号位不是1,值仍很大,成为一个很大的正数。

32.常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。
33.抽象类命名使用Abstract或Base开头;异常类命名使用Exception结尾;测试类命名以它要测试的类的名称开始,以Test结尾。
33.中括号是数组类型的一部分,数组定义如下:String[] args;请勿使用String args[]的方式来定义。
34.包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式,但是类名如果有复数含义,类名可以使用复数形式。
正例: 应用工具类包名为com.alibaba.open.util、类名为MessageUtils
35.枚举类名建议带上Enum后缀,枚举成员名称需要全大写,单词间用下划线隔开。
说明:枚举其实就是特殊的常量类,且构造方法被默认强制是私有。 正例:枚举名字:DealStatusEnum,成员名称:SUCCESS , UNKOWN_REASON。
36.各层命名规约:

A) Service/DAO层方法命名规约
· 获取单个对象的方法用get做前缀。
· 获取多个对象的方法用list做前缀。
· 获取统计值的方法用count做前缀。
· 插入的方法用save(推荐)或insert做前缀。
· 删除的方法用remove(推荐)或delete做前缀。
· 修改的方法用update做前缀。
B) 领域模型命名规约
· 数据对象:xxxDO,xxx即为数据表名。
· 数据传输对象:xxxDTO,xxx为业务领域相关的名称。
· 展示对象:xxxVO,xxx一般为网页名称。
· POJO是DO/DTO/BO/VO的统称,禁止命名成xxxPOJO。

37.long或者Long初始赋值时,必须使用大写的L,不能是小写的l,小写容易跟数字1混淆,造成误解。
38.大括号的使用约定。如果是大括号内为空,则简洁地写成{}即可,不需要换行;如果是非空代码块则:

1) 左大括号前不换行。
2) 左大括号后换行。
3) 右大括号前换行。
4) 右大括号后还有else等代码则不换行;表示终止右大括号后必须换行。

public static void main(String args[]) {
	// 缩进4个空格
	String say = "hello";
	// 运算符的左右必须有一个空格
	int flag = 0;
	// 关键词if与括号之间必须有一个空格,括号内的f与左括号,0与右括号不需要空格
	if (flag == 0) {
		System.out.println(say);
	}
	// 左大括号前加空格且不换行;左大括号后换行
	if (flag == 1) {
		System.out.println("world");
	// 右大括号前换行,右大括号后有else,不用换行
	
	} else {
		System.out.println("ok");
	// 在右大括号后直接结束,则必须换行
	}
}

39.单行字符数限制不超过 120 个,超出需要换行,换行时 遵循如下原则:

1.第二行相对第一行缩进 4 个空格,从第三行开始,不再继续缩进,参考示例。
2.运算符与下文一起换行。
3.方法调用的点符号与下文一起换行。
4.在多个参数超长,逗号后进行换行。
5.在括号前不要换行,见反例。

StringBuffer sb = new StringBuffer();
//超过120个字符的情况下,换行缩进4个空格,并且方法前的点符号一起换行
sb.append("zi").append("xin")...
.append("huang")...
.append("huang")...
.append("huang");

命名规范

名称 释义 类别 作用
src source 目录 存放源码
include include 目录 存放头文件
cmake cmake 目录 cmake构建文件
doc document 目录 存放工程说明文档
external external 目录 存放外部代码
funit functionUnit 目录 存放单体功能
mgr manager 文件目录夹 存放接口文件
service service 目录 存放脚本文件
.ini initial 初始化文件 存放可变因素
.bash bash 脚本文件 自动化执行
boot boot 函数名 启动
iface interface 目录 接口
rc ? 文件 一般代表配置文件,即启动时会执行的操作,
如:~/.bashrc会在启用bash的时候执行;如:/etc/rc.local会在开机时执行。
local local 目录 一般代表用来用户自定义的文件,
如:rc.local,就是区别于内置配置文件,提供用户用于自定义的配置文件
impl impl 文件/函数名 接口函数/接口类
boot boot 函数名 启动函数
manager manager 目录/文件名 顶层Api
on前缀 - 函数名 表示事件/重载
out前缀 - 函数名 出参,输出形参
schedule- 函数名 调度
caller - 函数名 主调函数
callee - 函数名 被调函数
get前缀 - 函数名 获取成员变量
is前缀 - 函数名 检测危险值
set前缀 - 函数名 设置成员变量
implements 后缀 虚函数的实现函数

有效性检测

1.函数返回值检测
一般函数只返回基本类型,其他类型使用出参方式。
返回基本类型时需要判断值的有效性,以出参方式的需要返回bool值。
2.函数入参检测
对传入的参数进行检测有效性(有无及阈值)。

程序优化

  • 短函数使用内联函数,因为函数跳转的开销较大。
posted @ 2020-05-11 06:29  多弗朗强哥  阅读(107)  评论(0编辑  收藏  举报