java命名规范

1、包的命名:
Java包的名字都是由小写单词组成。即便多个单词也全小写。示例:demopackage
2、类的命名:(首字母都要大写)
类名是以大写字母开头的名词。如果有多个单词组成,每个单词第一个字母应该大写(骆驼命名法)。不能使用Java保留字作为类名。示例:DemoClass
3、方法的命名:
方法的名字的第一个单词应以小写字母作为开头,后面的单词则用大写字母开头。示例:demoFunction
4、变量的命名:
首字母是小写的,接下来的单词都以大写字母开头。示例:demoParam
5、常量的命名 :
常量的名字应该都使用大写字母,并且指出该常量完整含义。如果一个常量名称由多个单词组成,则应该用下划线来分割这些单词。示例:IS_SUCCESS
6、参数的命名:
参数的命名规范和方法的命名规范相同,而且为了避免阅读程序时造成迷惑,请在尽量保证参数名称为一个单词的情况下使参数的命名尽可能明确。
7、自定义数据结构(首字母都要大写)
.如果使用到了设计模式,建议在类名中体现出具体模式。 说明:将设计模式体现在名字中,有利于阅读者快速理解架构设计思想。 正例:public class OrderFactory; public class LoginProxy; public class ResourceObserver;

  1. 【强制】大括号的使用约定。如果是大括号内为空,则简洁地写成{}即可,不需要换行;如果 是非空代码块则: 1) 左大括号前不换行。 2) 左大括号后换行。 3) 右大括号前换行。 4) 右大括号后还有 else 等代码则不换行;表示终止的右大括号后必须换行。

【强制】if/for/while/switch/do 等保留字与括号之间都必须加空格。

public static void main(String[] args) { // 缩进 4 个空格 String say = “hello”; // 运算符的左右必须有一个空格 int flag = 0; // 关键词 if 与括号之间必须有一个空格,括号内的 f 与左括号,0 与右括号不需要空格 if (flag == 0) { System.out.println(say); } // 左大括号前加空格且不换行;左大括号后换行 if (flag == 1) { System.out.println(“world”); // 右大括号前换行,右大括号后有 else,不用换行 } else { System.out.println(“ok”);
// 在右大括号后直接结束,则必须换行 }
}

【强制】方法参数在定义和传入时,多个参数逗号后边必须加空格。 正例:下例中实参的"a",后边必须要有一个空格。 method(“a”, “b”, “c”);

(七) 控制语句

  1. 【强制】在一个 switch 块内,每个 case 要么通过 break/return 等来终止,要么注释说明程 序将继续执行到哪一个 case 为止;在一个 switch 块内,都必须包含一个 default 语句并且 放在最后,即使它什么代码也没有。

【强制】在 if/else/for/while/do 语句中必须使用大括号。即使只有一行代码,避免使用 单行的形式:if (condition) statements;

【推荐】循环体中的语句要考量性能,以下操作尽量移至循环体外处理,如定义对象、变量、 获取数据库连接,进行不必要的 try-catch 操作(这个 try-catch 是否可以移至循环体外)。

【推荐】除常用方法(如 getXxx/isXxx)等外,不要在条件判断中执行其它复杂的语句,将复 杂逻辑判断的结果赋值给一个有意义的布尔变量名,以提高可读性。 说明:很多 if 语句内的逻辑相当复杂,阅读者需要分析条件表达式的最终结果,才能明确什么样的条件执行什么样的语句,那么,如果阅读者分析逻辑表达式错误呢? 正例: //伪代码如下 final boolean existed = (file.open(fileName, “w”) != null) && (…) || (…); if (existed) { … } 反例: if ((file.open(fileName, “w”) != null) && (…) || (…)) { … }

【推荐】表达异常的分支时,少用 if-else 方式,这种方式可以改写成:
if (condition) { … return obj; } // 接着写 else 的业务逻辑代码; 说明:如果非得使用 if()…else if()…else…方式表达逻辑,【强制】避免后续代码维 护困难,请勿超过 3 层。 正例:逻辑上超过 3 层的 if-else 代码可以使用卫语句,或者状态模式来实现。卫语句示例 如下:
public void today() { if (isBusy()) { System.out.println(“change time.”); return; }

if (isFree()) {  System.out.println(“go to travel.”);          return;     } 

System.out.println(“stay at home to learn Alibaba Java Coding Guideline.”); return; }

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值