如何提高代码可读性

先介绍一本好书

编写可读代码的艺术

以下代码可读性好吗？

if ( !isNotEmpty(str) ) {

} else {
    do();
}

这样写是不是更好？

if ( isEmpty(str) ) {

} else {
    do();
}

从外部加载页面
- Page getPage() { : 不够准确
- Page loadPage() { : 更准确一些
通过名字检索
- List<Person> getByName(String name) { : 不够准确，get方法一般只会返回1个对象
- List<Person> findByName(String name) { : 更准确一些

把Date转化为yyyyMMdd形式的字符串
- String toDateString(Date date) ：不够具体
- String toYYYYMMDD(Date date) ：更具体，基本上见名知意

字符串列表中返回符合条件的下标列表

写法1:

List<Integer> result = new ArrayList<>();
 //……
 return result;

写法2:

️List<Integer> matchedIndexes = new ArrayList<>();
 //……
 return matchedIndexes;

不可以省略的情况
- class WDate {} : 这里把War缩写成W就不知道什么意思了
- class WarDate {}
可以省略的情况
- Document doc = new Document(); : document缩写成doc基本不影响理解，而且基本是业界约定俗成的缩写
- Document document = new Document();
- Date convertToDate(String dateExpression, String datePattern);
- Date toDate(String dateExpression, String datePattern); ：去除convert这个单词也不影响意思表达
这里需要注意的是，命名并不是越长越好，名字太长，也会增加读者理解成本

检查文件大小
- public boolean isFileSizeOver(File file, int size)
- public boolean isFileSizeOver(File file, int size_kb) : 这里的参数名size_kb很好地传达了单位是kb, 可以使读者更好地理解方法的意图。
boolean型变量或方法，使用is, has, can, should等前缀
- if ( user.auth() ) {
- ` if ( user.hasAuthority() )` : 有has前缀，很容易理解该方法返回值类型为boolean

首先，我并不认为注释越多越好，长篇大论，同样也会增加阅读成本，浪费读者的时间。
不要写没有价值的注释，看代码就明白什么意思的情况不要写注释.

//通过名字检索
  List<Person> findByName(String name) {

//遍历array数组
  For (int i=0; i<array.count; i++) {

上面两个例子中的注释，是没有必要的，因为看代码其实已经理解意思了。这样的注释只是增加了代码行数。（除非你所在的公司会考核工程师的代码行数）

这里主要是要减少理解的曲折度，能直着说就别绕着说，减少理解代码所需的脑容量。

if-else条件语句尽量把肯定放在前面

写法1

if ( ! user.hasAuthority(“admin”) ) {
// ..
} else {
// ..
}

写法2

if ( user.hasAuthority(“admin”) ) {
// ..
} else {
// ..
}

写法2，if条件是肯定语句，更好理解一些。