提升java代码可读性应注意的几个细节

        作为码农，整天都在写代码，可是，如何写好高质量的代码，怎么让自己的代码更具可读性呢？你是否还是只关注代码的功能而忽略代码的优雅呢？写好优雅的代码需要注意以下几个事项

     

避免在方法中出现多个return语句（退出点）：

在你的方法中，确保只有一个  退出点。不要在一个方法中使用多于一个return语句。

如，下面的代码是  不推荐的，因为它有多个退出点（return语句）。

private boolean isEligible(int age){
  if(age > 18){
    return true;
  }else{
    return false;
  }
}

上面的代码可以这么写（当然，下面的代码还可以改进，后面再说）。

private boolean isEligible(int age){
  boolean result;
  if(age > 18){
    result = true;
  }else{
    result = false;
  }
  return result;
}

简化if-else方法：

我们写了一些只要一个参数的工具方法，检查一些条件并根据条件返回一个值。如，在上面见到的  isEligible方法。

private boolean isEligible(int age){
  boolean result;
  if(age > 18){
    result = true;
  }else{
    result = false;
  }
  return result;
}

可以只使用一个return语句来重写此方法。

private boolean isEligible(int age){
  return age > 18;
}

不要为Boolean，Integer或String创建新的实例：

避免创建新的Boolean，Integer，String等实例。使用Boolean.valueOf(true)代替new Boolean(true)。两种写法效果差不多但却可以改善性能。

在代码块周围使用大括号:

永远不要忘记在块类型语句（如：if,for,while）周围使用大括号。这可以减少代码歧义并且避免在你修改代码块的时候产生新的bug。

不推荐

if(age > 18)
  return true;
else
  return false;

推荐

if(age > 18){
  return true;
}else{
  return false;
}

把方法的参数声明为final类型:

总是在所有兼容的地方把把方法的参数声明为final。这样做的话，当你无意中修改了参数的值，编译时会得到警告，并且编译生成的字节码也会得到优化。

推荐

private boolean isEligible(final int age){ ... }

用大写命名public static final类型成员变量：

总是使用大写命名用public static final类型变量。这样可以让你很容易区分常量和本地变量。

不推荐

public static final String testAccountNo = "12345678";

推荐

public static final String TEST_ACCOUNT_NO = "12345678";

把多个if语句合并成一个：

下面的代码

if(age > 18){
  if( voted == false){
    // eligible to vote.
  }
}

可以使用一个if语句改写为：

if(age > 18 && !voted){
  // eligible to vote
}

别忘了给switch添加default语句：

总是给switch添加一个default语句。

避免  重复  使用同样的字符串，创建一个常量吧：

如果你需要在多个地方使用同一个字符串，那就创建一个字符串常量来使用吧。

下面的代码：

private void someMethod(){
  logger.log("My Application" + e);
  ....
  ....
  logger.log("My Application" + f);
}

可以创建一个常量代替字符串"My Application"：

public static final String MY_APP = "My Application";

private void someMethod(){
  logger.log(MY_APP + e);
  ....
  ....
  logger.log(MY_APP + f);
}