1.命名规则
- 所有变量，方法名和类名都应该遵循CamelCase风格。唯一不同的是，类名的首字母要大写。
class UserService {
private String firstName;
public String getFirstName() {
return firstName;
}
}
- 常量全部使用大写字母并且以下划线分割
final int MAX_AGE = 20;
- 变量名或者方法名不应包含太多单词。越简单越好，同时要能表达出意图。
//This is a BAD practice
public void saveUserIntoMongoDBDatabase(User user);
//This is much better
public void saveUser(User user);
2.写你所想
定义一个变量时不要偷懒，给它一个全名，而不是名字里的一个字母。变量名应该能表达出他的值。即便你知道这个变量是干嘛的，并不意味其他开发者也知道。同时当你过一阵时间再来看这段代码时，也可能记不起这个变量的含义。
让我们看看下面的一段代码：
public boolean check() {
if (a < max) {
return true;
} else {
return false;
}
}
这段代码非常不清晰，其他开发当然也不明所以。我们重构一下，看看怎么更好地写这段代码。
public boolean isAgeAcceptable() {
if (userAge < maxAge) {
return true;
} else {
return false;
}
}
3. 变量/方法声明
类的变量应该在其顶部声明。如此一来，你总能知道去哪里看变量的声明而不是滚动整个文件去寻找。
如果一个变量只在一个方法中使用，那么将其声明为一个局部变量即可。
方法声明的顺序应该和它们使用的顺序一致(从上而下)。举个栗子，如果一个方法调用当前的方法，那么这个方法应该声明当前方法的下面。
同时，越重要的方法就应该声明在前面。
4. 单一职责
一个方法应该只负责一件事情。如果你的方法同时做啦两件以上不同的事情，你应该这个方法的一些功能移到其他方法。
这样的方法才容易理解，扩展和被其他方法复用。
举个栗子，你有一个方法saveUserAndChargeCard()，将用户保存到数据库并且刷用户的信用卡。这个方法不好，因为他名字包含And而且干啦两件事。在方法命中避免使用and和or等等。你可以将这个方法分成saveUser()和chargeCard().
5.短方法
对开发这而言，短方法的长度并没有一个标准的准则。可能有人说最多10行，有些人说最多五行，有些情况下20行也是可以的。所以究竟多少才合适呢？事实上，并木有一个标准答案。尽量使你的方法越短越好。通常5到10行为最佳。当然你的方法有12行或则15行也不会有人打你的，但是要保证你这15行代码的可理解性和高质量。
6.最小化你的代码
能用一行搞定的就别用三行。这意味着你写代码时考虑下最佳的方式。
看看下面的例子：
boolean hasCreditCard(User user) {
if (user.hasCard) {
return true;
} else {
return false;
}
}
乍看之下，好像并无不妥，但是这段其实可以简化一下。
boolean hasCreditCard(User user) {
return user.hasCard;
}
看到没，一行抵过五行，所以下笔前三思囖。
7.重复是原罪
在你的工程里避免代码冗余。如果你的方法不能在其他地方复用，那么想个更好的方式去实现它。你的方法应该尽可能地通用。这也将有助于你的小伙伴直接使用你的方法而不是再去写一个。
8. 注释
注释在以前一段时间内都是开发者的日常操作，现在有些不同啦，如果你给你的代码加啦一段注释，那么说明你的代码不能自解释，你应该选择一个更好的方法来实现它。
注释存在的另一个问题是，开发在经常去改代码去忘啦改注释。
当然如果你写啦一段很复杂的算法，你的注释将帮助其他程序员理解。
9. 代码检测工具
即便你采纳啦以上的所有建议，我也推荐你使用一些工具来检查你的代码质量。这个工具可以扫描你的代码，并指出你出错的地方。因为你人工检查时可能会遗漏。
其中一个工具是SonarQube.一款代码质量分析的优秀产品。
10.最佳实践
无论你在实现什么功能，我想有人在你之前就已经做过啦。所以在你实现这个需求之前可以先调研一下。
网友评论