1.代码地址: github
2.代码审查检查表
| 功能模块名称 | 二叉树的基本操作 | ||
|---|---|---|---|
| 审查人 | 罗园龙 | 审查日期 | 2019.4.24 |
| 代码名称 | BalanceTree | 代码作者 | 李康康 |
| 重要性 | 激活 | 级别 | 检查项 |
| 总计 | |||
| 命名 | |||
| 重要 | Y | 20 | 命名规则是否与所采用的规范保持一致? |
| Y | 20 | 是否遵循了最小长度最多信息原则？ | |
| 重要 | 50 | has/can/is前缀的函数是否返回布尔型？ | |
| 注释 | |||
| 重要 | Y | 10 | 注释是否较清晰且必要？ |
| 重要 | N | 10 | 复杂的分支流程是否已经被注释？ |
| N | 10 | 距离较远的}是否已经被注释？ | |
| N | 10 | 非通用变量是否全部被注释？ | |
| 重要 | Y | 50 | 函数是否已经有文档注释？（功能、输入、返回及其他可选） |
| 10 | 特殊用法是否被注释？ | ||
| 声明,空白,缩进 | |||
| Y | 20 | 每行是否只声明了一个变量？（特别是那些可能出错的类型） | |
| 重要 | Y | 40 | 变量是否已经在定义的同时初始化？ |
| 重要 | Y | 40 | 类属性是否都执行了初始化？ |
| Y | 20 | 代码段落是否被合适地以空行分隔？ | |
| Y | 20 | 是否合理地使用了空格使程序更清晰？ | |
| Y | 20 | 代码行长度是否在要求之内？ | |
| Y | 20 | 折行是否恰当？ | |
| 语句/功能分布/规模 | |||
| Y | 20 | 包含复合语句的{}是否成对出现并符合规范？ | |
| Y | 20 | 是否给单个的循环、条件语句也加了{}？ | |
| Y | 40 | if/if-else/if-else if-else/do-while/switch-case语句的格式是否符合规范？ | |
| Y | 20 | 单个变量是否只做单个用途？ | |
| 重要 | Y | 20 | 单行是否只有单个功能？（不要使用；进行多行合并 |
| 重要 | Y | 40 | 单个函数是否执行了单个功能并与其命名相符？ |
| Y | 20 | 操作符＋＋和— —操作符的应用是否复合规范？ | |
| 规模 | |||
| 重要 | Y | 20 | 单个函数不超过规定行数？ |
| 重要 | Y | 100 | 缩进层数是否不超过规定？ |
| 重要 | Y | 100 | 是否已经消除了所有警告？ |
| 重要 | Y | 40 | 常数变量是否声明为final？ |
| 重要 | Y | 80 | 对象使用前是否进行了检查？ |
| 重要 | Y | 80 | 局部对象变量使用后是否被复位为NULL？ |
| 重要 | 70 | 对数组的访问是否是安全的？（合法的index取值为[0, MAX_SIZE-1]） | |
| 重要 | Y | 20 | 是否确认没有同名变量局部重复定义问题? |
| Y | 20 | 程序中是否只使用了简单的表达式？ | |
| 重要 | Y | 20 | 是否已经用（）使操作符优先级明确化？ |
| 重要 | N | 20 | 所有判断是否都使用了（常量==变量）的形式？ |
| 80 | 是否消除了流程悬挂？ | ||
| 重要 | Y | 80 | 是否每个if-else if-else语句都有最后一个else以确保处理了全集？ |
| 重要 | 80 | 是否每个switch-case语句都有最后一个default以确保处理了全集？ | |
| 80 | for循环是否都使用了包含下限不包含上限的形式？（k=0; k<MAX） | ||
| 重要 | 40 | XML标记书写是否完整，字符串的拼写是否正确? | |
| 40 | 对于流操作代码的异常捕获是否有finally操作以关闭流对象? | ||
| 20 | 退出代码段时是否对临时对象做了释放处理? | ||
| 重要 | 40 | 对浮点数值的相等判断是否是恰当的？（严禁使用==直接判断） | |
| 可靠性(函数) | |||
| 重要 | Y | 60 | 入口对象是否都被进行了判断不为空？ |
| 重要 | Y | 60 | 入口数据的合法范围是否都被进行了判断？(尤其是数组) |
| 重要 | N | 20 | 是否对有异常抛出的方法都执行了try...catch保护？ |
| 重要 | Y | 80 | 是否函数的所有分支都有返回值？ |
| 重要 | 50 | int的返回值是否合理？（负值为失败，非负值成功） | |
| 20 | 对于反复进行了int返回值判断是否定义了函数来处理？ | ||
| 60 | 关键代码是否做了捕获异常处理? | ||
| 重要 | Y | 60 | 是否确保函数返回CORBA对象的任何一个属性都不能为null? |
| 重要 | Y | 60 | 是否对方法返回值对象做了null检查，该返回值定义时是否被初始化? |
| 重要 | 60 | 是否对同步对象的遍历访问做了代码同步? | |
| 重要 | 80 | 是否确认在对Map对象使用迭代遍历过程中没有做增减元素操作？ | |
| 重要 | 60 | 线程处理函数循环内部是否有异常捕获处理，防止线程抛出异常而退出? | |
| 20 | 原子操作代码异常中断，使用的相关外部变量是否恢复先前状态? | ||
| 重要 | Y | 10 | 函数对错误的处理是恰当的？ |
| 可维护性 | |||
| 重要 | Y | 实现代码中是否消除了直接常量？（用于计数起点的简单常数例外 | |
| Y | 100 | 是否消除了导致结构模糊的连续赋值？（如a= (b=d+c )） | |
| N | 20 | 是否每个return前都要有日志记录? | |
| Y | 20 | 是否有冗余判断语句？（如：if (b) return true; else return false;） | |
| Y | 20 | 是否把方法中的重复代码抽象成私有函数? |
3.代码评价
代码原理分析:
这段java代码实现了二叉树的基本操作,如 求二叉树的节点个数,二叉树的最大层数,二叉树的最小深度,以及先序遍历,中序遍历,后序遍历以及分层遍历.
1.求二叉树的节点个数
递归解法:
（1）如果二叉树为空，节点个数为0
（2）如果不为空，二叉树节点个数 = 左子树节点个数 + 右子树节点个数 + 1
参考代码如下：
public static int getNodeNumRec(TreeNode root) {
if (root == null) {
return 0;
}
return getNodeNumRec(root.left) + getNodeNumRec(root.right) + 1;
}
2.求二叉树的最大层数
递归解法：
（1）如果二叉树为空，二叉树的深度为0
（2）如果二叉树不为空，二叉树的深度 = max(左子树深度， 右子树深度) + 1
代码如下：
public int maxDepth(TreeNode root) {
if(root == null)
return 0;
return Math.max(maxDepth(root.left), maxDepth(root.right))+1;
}
3.求二叉树的最小深度
最小深度是从根节点到最近叶子节点的最短路径上的节点数量.
代码如下:
public int minDepth(TreeNode root) {
if(root == null)
return 0;
int left = minDepth(root.left);
int right = minDepth(root.right);
return (left == 0 || right == 0) ? left + right + 1 : Math.min(left, right) + 1;
}
4.先序遍历
给定二叉树，返回其节点值的前序遍历
代码如下:
public List<Integer> preorderTraversal(TreeNode root) {
LinkedList<Integer> res = new LinkedList<>();
if(root == null)
return res;
Stack<TreeNode> stack = new Stack<>();
stack.push(root);
while(!stack.isEmpty()){
TreeNode node = stack.pop();
res.add(node.val);
if(node.right != null){
stack.push(node.right);
}
if(node.left != null){
stack.push(node.left);
}
}
return res;
}
4.中序遍历
给定二叉树，返回其节点值的中序遍历
public List<Integer> inorderTraversal(TreeNode root) {
List<Integer> res = new ArrayList<Integer>();
if(root == null)
return res;
Stack<TreeNode> stack = new Stack<TreeNode>();
TreeNode cur = root;
while(!stack.isEmpty() || cur != null){
if(cur != null){
stack.push(cur);
cur = cur.left;
}else{
cur = stack.pop();
res.add(cur.val);
cur = cur.right;
}
}
return res;
}
5.后序遍历
给定二叉树，返回其节点值的后序遍历.
代码如下:
public List<Integer> postorderTraversal(TreeNode root) {
LinkedList<Integer> ans = new LinkedList<>();
Stack<TreeNode> stack = new Stack<>();
if (root == null) return ans;
stack.push(root);
while (!stack.isEmpty()) {
TreeNode cur = stack.pop();
//采用逆序插入的方式
ans.addFirst(cur.val);
if (cur.left != null) {
stack.push(cur.left);
}
if (cur.right != null) {
stack.push(cur.right);
}
}
return ans;
}
6.分层遍历
给定二叉树，返回其节点值的级别顺序遍历
代码如下:
public List<List<Integer>> levelOrder(TreeNode root) {
List<List<Integer>> res = new ArrayList<List<Integer>>();
if(root == null)
return res;
Queue<TreeNode> queue = new LinkedList<TreeNode>();
TreeNode cur = null;
queue.add(root);
while(!queue.isEmpty()){
ArrayList<Integer> level = new ArrayList<Integer>();
int l = queue.size();
for(int i=0; i<l;i++){
cur = queue.poll();
level.add(cur.val);
if(cur.left != null)
queue.add(cur.left);
if(cur.right != null)
queue.add(cur.right);
}
res.add(level);
}
return res;
}
代码整体评价:
- 代码较为规范,有必要的注释
- 变量命名遵循java的推荐规范,使用了驼峰命名法
- 单个函数执行单一的功能,代码行数少
- 缺少对异常的捕获和处理
- 后序遍历使用了非递归的方法,代码行数多
代码优点:
- 尽量使用了java.util包的类,避免了自己写实现代码时出现错误的可能性,如使用了 java.util包的Queue类,ArrayList类,Stack类,使得程序健壮性有所提高.
- 代码风格清晰明了,{}使用得当,表达式里使用了使可读性提高的空格,多个变量分开多行声明,且变量名很规范,清晰易懂.
- 代码的每个子函数功能都有注释,且函数的代码功能实现了单一的功能,代码行数少,可读性和可维护性较高.
代码缺点
- 没有异常处理部分,出现异常参数,会使程序奔溃.
4.总结
此次代码审查,李康康的代码写的很棒,很有借鉴意义,参数命名很规范,没有出现一些如用用拼音做变量名的低级错误,代码的每一部分都很清晰,功能简单易懂,不错乱,读起来很顺畅,让我看到了李康康同学的较强的编程功底,时刻提醒我要有和他一样的编程习惯.
来源：https://www.cnblogs.com/Luoyuanlong/p/10770467.html