Java写代码规范
一、关键字和保留字
- 关键字(Keyword)
定义:被 Java 语言赋予了特殊含义,用作专门用途的字符序列(单词)
特点:关键字中的所有字母都是小写 - 保留字(reserved word)
定义:指现有 Java 版本尚未使用,但以后版本可能会作为关键字使用的字符序列
写程序的时候要避免使用关键字和保留字。
二、标识符命名规则
2.1命名规则
- 由英文大、小写字母,数字 0~9,_或$组成。
- 不可以用数字作为开头。
- 不可以使用关键字和保留字,但可以包含。
- Java 严格区分大小写,长度无限制。
- 标识符不能包含空格。
如果不遵守以上规则,则编译不通过。
2.2使用建议
- 标识符应做到见名知意,如
UploadImage,一看就知道是上传图片用的。 - 包名:多单词组成时所有字母都用小写:xxxyyyzzz
- 类名、接口名:多单词组成时,所有单词的首字母大写:XxxYyyZzz
- 变量名、方法名:多单词组成时,第一个单词的首字母小写,从第二个单词开始每个单词的首字母大写:xxxYyyZzz
- 常量名:所有字母都大写。多单词组成时,单词与单词之间用下划线连接:XXX_YYY_ZZZ
Java 使用 Unicode 字符集,因此允许使用汉字来进行命名。
三、良好的编程风格
3.1注释的使用
- 为程序添加注释。并使用良好的注释风格
- 使用文档注释来注释整个类或整个方法
- 如果注释方法中的某个步骤,使用单行或多行注释
为了提高程序的可读性,方便以后修改和维护。我们应该养成给程序添加注释的良好习惯。
Java 中的注释分为以下三种:
- 单行注释
以双斜杠//标识,只能注释一行内容,用在注释信息内容少的地方。1
//这里是单行注释
- 多行注释
包含在/*和*/之间,能注释很多行的内容。多行注释不允许嵌套。1
2
3/*
这里是多行注释
*/ - 文档注释
包含在/**和*/之间,也能注释多行内容,一般用在类、方法和变量上面,用来描述其作用。文档注释可以通过 javadoc 命令提取,生成对应的 html 文档。1
2
3
4
5/**
程序的简单描述
@author 程俞客
@version 1.0
*/
3.2写代码规范
- 适当的增加缩进和空白,提高程序的可读性
- 使用 tab 键实现缩进
- 运算符两边习惯各加一个空格,例如 2 + 3 * 4
- 代码块使用行尾风格或者次行风格
- 建议使用行尾风格与 Java API 源码一致
本博客所有文章除特别声明外,均采用 CC BY-NC-SA 4.0 许可协议。转载请注明来源 程俞客&称心号!
评论















