1. 名称（属性、变量、参数、函数、类名）是否真实反映出其意图？
2. 函数是否过长？（推荐 80 行以内）
代码太长，如果中间某个子功能有问题需要排查或者去改造，通常需要将前面的代码都看懂，非常痛苦
可以把每个子功能独立为一个子函数，排查问题或者改造某个子功能更容易
public void someFunction(){
// 第 1 个子功能 30 行
// 第 2 个子功能 60 行
// 第 3 个子功能 40 行
// 第 4 个子功能 70 行
// 第 5 个子功能 55 行
}
有些规定不超过 80 行，有些可能规定不超过 90 行。只是一个“推荐值”，不要教条，其目的还是让代码变得更清晰易读，具体行数只要团队达成共识即可
3. 子函数是否在同一抽象层级？
可以将代码行数较多的函数根据子功能提取到子函数中。但是如果函数的层级不同，则应该将相同层级放在同一个函数中
public void someFunction(){
// 第 1 个子功能 30 行 层级 1
// 第 2 个子功能 60 行 层级 2
// 第 3 个子功能 40 行 层级 1
// 第 4 个子功能 70 行 层级 2
// 第 5 个子功能 55 行 层级 1
}
比如可以将第 1、3、5 子功能提取到独立的子函数，放在 someFunction 函数中调用，然后将第 2、4 个子功能提取到独立的子函数中在第 1、3 或 5 子函数调用
4. 注释是否清晰？可能让其他开发人员产生困惑的代码是否有文档解释或者注释说明？
1、如编写工具类时，可以参考
org.apache.commons.lang3.StringUtils#defaultString(java.lang.String)
的注释，将常见的参数和结果加到注释中，对调用者非常友好：
/**
* <p>Returns either the passed in String,
* or if the String is {@code null}, an empty String ("").</p>
*
* <pre>
* StringUtils.defaultString(null) = ""
* StringUtils.defaultString("") = ""
* StringUtils.defaultString("bat") = "bat"
* </pre>
*
* @see ObjectUtils#toString(Object)
* @see String#valueOf(Object)
* @param str the String to check, may be null
* @return the passed in String, or the empty String if it
* was {@code null}
*/
public static String defaultString(final String str) {
return defaultString(str, EMPTY);
}
2、如在编写前端接口或者封装二方或三方接口调用时，可以将相关枚举引用、相关接口文档链接，对接说明文档链接等放到注释中方便后面快速理解上下文
/**
* xxx 功能
* 对接文档 {@link <a href="https://gitbook.cn/"/>}
*/
public Result someFunction(Object param) {
// ...
}
