好的代码规范可以改善其可读性,如果能让别人在很短的时间内就能读懂自己的代码,那么这段代码就是成功的。如果书写没有规范,就算是自己写的,时间一久,可能自己看起来都费劲。所以,一定要养成一个良好的代码书写习惯。我一开始学Java,最先看的就是代码规范,下面是我的一些总结。
命名规范
- **标识符: **所有的标识符只能英文用字母的大小写(az||AZ)、数字(0~9)、下划线(_)、美元符号($)、以及Unicode字符集中符号大于0xC0的所有符号连接组合而成,各符号之间不能有空格。标识符的第一个符号必须是字母、下划线和美元符号,后面可以是前面所说的任意符号。
- 类名:类名一般是由名词词性的英文单词构成,每个单词的首字母大写。
- 方法名:方法名一般是一个动词或者是动词词组,除了第一个单词首字母要小写外,其余单词的首字母均为大写。
- 变量名:变量名第一个字母小写,其余的单词首字母大写。尽量避免单字符变量,所取变量名应该要简短易懂,顾名思义,便于记忆。
- 常量:常量声明应该全部大写,每个单词之间用下划线连接。
- 包名:一个唯一包名的前缀总是全部小写的字母。
- 接口:接口的每个单词首字母都要大写。
注释规范
- 文档注释:对整个程序的功能做说明,用“/** */”进行注释。
- 多行注释:对某个功能模块作说明,用“/* */”进行注释。
- 单行注释:对某个语句作说明,用“//”进行注释。
- 其他说明:每个源文件都应该在开头加一个注释,列出文件名、日期和类的功能概述,除类的main()以外,每个方法都要有文档注释,每个属性都要加注释,注释要使用中文,代码中至少要包含15%的注释。
声明规范
- 不要将不同类型的变量声明放在同一行。
- 只在代码块的开始处声明变量。
- 方法与方法之间要有空行。
- 变量要在声明时进行初始化。
其他规范
- 一个Java源文件只写一个类。
- 文件名与类名相同。
- 一个类的代码不超过200行,一行不超过60个字符。
- if语句要用“{ }”括起来。
- for语句的初始化或者更新子句中要避免使用3个以上变量。
- return语句的返回值不用小括号。
- 可用IDE的格式化功能对代码进行缩进。