前言:
俗话说:没有规矩,不成方圆。我们写代码也是一样,代码规范就是我们写代码的规矩。举个简单的例子,我们在公司开发完一版软件之后,因为软件要优化、迭代。公司有很多人来参加这个项目,其他要想轻松上手,首先他们要看懂我们的代码,如果我们写的代码只有自己能看懂,那么会给公司带来很大的麻烦,我们自己在编程之路上也是很难存活下去的。
正文:
说道代码规范,我们先看看它的优点:
1.规范的代码可以减少很多的bug.
2.统一规范,方便阅读、维护,提高代码质量
3.统一格式,使代码度量更加精确,为公司软件过程体系优化打好基础,为后续交接工作提供依据。
4.节省很多的时间
5.节省很多的成本
我们看了代码规范有这么多优点,那赶快学学怎么让代码更加规范吧。
一、首先就是命名规范
1.1 命名原则
- 名字应该能够标识事物的特性,并且与业务挂钩。
- 名字一律使用英文单词,而不能为拼音。
- 名字可以有两个或三个单词组成,但不应多于4个,控制在3至30个字母以内。
- 在名字中,多个单词用大写第一个字母(其它字母小写)来分隔。例如:IsSuperUser。
- 命名避免和以下关键字冲突
- 方法名、参数名统一使用驼峰命名法(Camel命名法),除首字母外,其他单词的首字母大写,其他字母小写,类名每个组合的单词都要大写;
- 所有变量、方法、类名:见名知意
- 类成员变量:首字母小写和驼峰原则: monthSalary
- 局部变量:首字母小写和驼峰原则
- 常量:大写字母和下划线:MAX_VALUE
- 类名:首字母大写和驼峰原则: Man, GoodMan
- 方法名:首字母小写和驼峰原则: run(), runRun()
1.2 注释(三种)
单行注释:
“//……”
块注释:
“/*……*/”
文档注释:
“/**……*/”
1.3 编码风格规则
编码过程中需遵循以下风格习惯:
代码未写,文档先行,注释必须按照固定统一范式撰写。
关系运算必须常量在左、变量在右。
不许使用复杂的运算表达式,必要时添加括号而不依赖于优先级。
魔鬼数字需用宏定义替代。
局部变量必须初定义、避免不必要的内存操作、内存操作必须考虑异常处理。
1.4 版本命名规范
当源码包初版时,版本号为 V1.00;
当源码包被局部修改或bug修正时,发行号不变,修改号第二个数字增1。例如,对初版源码包作了第一次修订,则版本号为 V1.01;
当源码包在原有的基础上增加部分功能,发行号不变,修改号第一个数字增1,例如,对V1.12版的基础上增加部分功能,则新版本号为 V1.20;
当源码包有重要修改或局部修订累积较多导致源码包发生全局变化时,发行号增1。例如,在 V1.15 版的基础上作了一次全面修改,则新版本号为 V2.00。
有了代码规范,我们写代码轻松了许多,也给其他人带来了很多方便,何乐而不为呢!