【Java】代码规范

参考《码出高效：Java开发手册》~

是一个读书笔记~

目录

命名规范

包名

类名

变量

常量

代码编写规范

命名规范

所有的命名都需要能看出代码的作用，使用英文单词进行命名

包名

使用小写字母，相邻的点之间只能有一个单词，使用单数形式

例：

import java.util.stream.*;

如果类名有复数含义，则可以使用复数

如：

import java.util.stream.Collectors;

类名

使用大驼峰命名法，即首字母大写，其他单词首字母大写

自定义异常类需要在最后加上Exception

自定义枚举类需要在最后加上Enum

抽象类使用Abstract或Base开头

测试类命名以要测试的类的类名开头，以Test结尾

例：

class InputStream{}

class TypeEnum{}

class UserTest{}

class GlobalException extends Exception{}

变量

使用小驼峰命名法，首字母小写，对于布尔类型的变量不要将is作为前缀命名，在某些框架解析时可能发生错误。

而数据库的字段是推荐使用is作为前缀表达是与否的含义的，所以在进行数据库字段和成员变量进行映射时，需要手动指定映射规则。（MyBatis的使用）

例：

String userPassword;

常量

全局常量，使用public static final修饰，单词间使用下划线隔开，全部字母大写

如：

public static final MAX_LEVEL = 3;

类内常量，使用private static final修饰，单词间使用下划线隔开，全部字母大写

如：

private static final CONTANT_PREFIX = "bussiness";

局部常量，包括方法内常量，代码块内常量，方法参数常量（参数被final修饰），命名规则和变量一致，使用小驼峰命名法即可。

对于那些有意义的值，最好给值一个名称。

比如在数据库表中，有个字段用于记录用户状态，0表示正常状态，1表示被禁言，2表示账号注销，诸如此类。

在代码的逻辑判断中，如果直接使用0，1，2来进行判断，代码的阅读者就不知道代表的含义。

可以使用枚举类或者直接使用常量来表示：

private static final int USER_STATUS_NORMAL = 0;
private static final int USER_STATUS_STOP_POST= 1;
private static final int USER_STATUS_CANCEL = 2;

代码编写规范

缩进推荐使用四个空格来表示层级关系，而不使用tab，这是由于不同编辑器对于tab的解析不同，当然有些编辑器支持将tab表示为四个空格，包括idea和eclipse

空格的使用：

• 对于运算符的前后需要加上空格；
• 左括号（大小括号都一样）前加上空格；
• 如果方法有多个参数，在定义和传入参数时，逗号后面加上空格；
• 注释// 和注释内容之间有一个空格；

换行符的使用：

• 方法和方法之间，类和类之间，方法和属性之间可以用换行隔开，不同逻辑的代码，不同业务的代码也可以用空行隔开；
• 如果if (success) {} 大括号里没内容就不要用换行符；
• 当一行内容很多需要换行时，将运算符一起换行；
• 在左大括号后换行；

注释遵循三个原则：

• 一定要写注释
• 注释要精简
• 如果注释所解释的代码发生了修改，那么注释也一定要更改

今天的分享到这里啦，最近就打算分享一些读书笔记~

最后，问一个问题，大家写注释的时候用的是中文还是英文？

开发入门中，欢迎指教~