Java基础--Java编程规范

Posted 2020-07-18

IsCoder 标记: Java基础,Java编程规范

摘要：Java虽然没有强制性的编程规范，但是为了便于统一，Java有不成文的编程规范，为了形成良好的编程习惯，建议熟悉并遵守Java编程规范，提高代码的阅读性。

一、Java标识符

在任何语言中，都要自己的一套标识符规则。Java的标识符包括：Java关键字、Java特殊功能的标识符、合法的用户自定义标识符。其中，我们能改变的只有自定义的标识符，和大部分计算机编程语言一样，Java标识符原始只支持ASCII的编码，但是随着Java在世界的影响力，Java目前支持Unicode编码，即支持当前任何自然语言。需要指出的是，即使Java支持除英文外的其他语言，如中文，但是在实际开发中，主要还是用英文，这样做能避免各种莫名奇妙的错误。

1.1 Java标识符的组成：

①26个英文字母（包括大小写）

②数字0~9

③美元符号$

④下划线_

1.2 Java标识符注意事项

①不能以数字开头

②起名要做到见名知意

③符合Java编程规范

④不能和Java关键字和特殊功能标识符重名

二、Java编程规范

2.1 Java标识符的命名规范

标识符	命名规范	举例
包名	公司域名倒序+模块名（模块划分）/公司域名倒序+功能名（功能划分）【小写】	com.itheima.teacher/com.itheima.add
类名 接口	驼峰命名法 每个单词首字母大写，便于区分开每个单词，不至于组成新单词造成歧义	class StudentManage
方法名 变量名	第一个单词全部小写，从第二个单词开始首字母大写（如果有）	public void setName() String name
常量	单词全部大写，单词与单词之间用下划线隔开（如果有）	MAX_VALUE

2.2 Java编程规范

和Java的标识符命名规范一样，Java编程规范不是强制性规则，但是良好的编程习惯对于提高编程能力有百利而无一害。

第一、始终显式给出编译器系统隐藏的关键字、语句、修饰符、构造器…

第二、大括号成对书写，并且与对齐，左花括号前面要有空格

第三、运算符两侧要有空格

第四、并排语句之间加空格，如for语句

第五、方法和代码块之间加空行，使代码看上去更清晰

第六、方法的功能要添加多行注释，成员变量要加单行注释，类要加文档注释

… …

三、Java注释

3.1 单行注释

Java的注释，沿袭了C和C++的代码注释风格，单行注释，是C++注释风格，采用“双左斜杠//”注释，一般单行注释用于变量和常量的注释。

3.2 多行注释

多行注释，和C语言的注释风格一样，采用“/*…*/”。当注释比较详细不能在一行写完时，使用多行注释，常用于对各种方法的功能进行注释。

3.3 文档注释

文档注释，是Java的特有注释风格，便于提炼类的使用说明书（API使用指南），常用于对类、接口和方法进行详细描述。

3.4 注释的作用

第一、注释可以提高程序的可阅读性，不管是阅读的代码还是阅读他人的，注释是必不可少的。

第二、当出现编译报错时，如果程序行数非常多，可以将错误行注释掉，缩小排除范围，提高查bug的效率。