java 代码审查_代码审查（Code Review）清单

代码审查可以帮助提高代码质量，避免由于代码习惯而造成的 bug。下面列出的这些要点因该可以作为大部分代码审查的指导，如果是 Java 应用的话，这些建议应该被视作最佳实践。

文档

1. Javadoc 应该在每一个类和方法中添加。

2. 如果是修复某个 bug，应该添加 bug ID。

3. 走捷径的方法或者复杂的逻辑要有解释。

4. 如果代码会被公开，每个文件头都要标注版权信息。

5. 复杂的 HTML，JavaScript，CSS 应该包含文档。

功能

1. 如果类似的逻辑被使用了多次，应该把它写成一个帮助类，然后在多出调用。

2. 鼓励使用 API 而不是重复编写代码解决相同的问题。

3. 要强调代码的单元测试。

4. 任何新加的代码不应该破坏已有的代码。

5. 假如是 Web 应用，JSP 不应该包含 Java 代码。

安全

1. 任何代码都不能执行用户的输入，除非转义过了。这个常常包含 JavaScript 的 eval 函数和 SQL 语句。

2. 禁止那些在短时间内提交非常多请求的 IP。

3. 任何类，变量，还有方法都应该有正确的访问域。

4. 尽量避免使用 iframe。

性能

1. 所有数据库和文件操句柄在不需要的时候都应该被关闭。

2. SQL 语句的写法会导致性能千差万别。

java 代码审查_代码审查（Code Review）清单相关推荐

代码走查和代码审查_代码审查随时间而变化
代码走查和代码审查我们已经进行了大约4年的代码审查 . 代码审查入门从一开始,开发人员就会互相帮助,在有人询问时查看代码,或者有时主管或高级开发人员会介入并检查代码,如果我们发现测试存在问题,或者 ...
代码走查和代码审查_如何避免代码审查陷阱降低生产率
代码走查和代码审查 Code reviewing is an engineering practice used by many high performing teams. And even tho ...
审查指南最新版本_代码审查-最终指南
审查指南最新版本 by Assaf Elovic 通过阿萨夫·埃洛维奇代码审查-最终指南 (Code Review - The Ultimate Guide) 构建团队代码审查流程的终极指南 (T ...
工具的特性_16 个好用的 Code Review 工具
作者 | Guru99 译者 | 刘雅梦策划 | 小智来源:GitHubDaily 原文链接:https://mp.weixin.qq.com/s/xwqVD69o6_qrgV0dxj_2aw C ...
作为开发人员，这四类Code Review方法你都知道吗？
本文翻译自:https://dzone.com/articles/4-types-of-code-reviews-any-professional-developer 转载请注明出处:葡萄城官网,葡萄 ...
谈谈对代码审查Code Review的简单认识
谈谈对代码审查Code Review的简单认识 Code Review(代码审查)是软件开发中的最佳实践之一,可以有效提高整体代码质量,及时发现代码中可能存在的问题.包括像Google.微软这些公司, ...
什么是Code Review 代码审查
Code Review 是一种通过复查代码提高代码质量的过程,在XP方法中占有极为重要的地位,也已经成为软件工程中一个不可缺少的环节. 本文通过对Code Review的一些概念和经验的探讨,就如何进 ...
Eclipse Code Review（代码审查）工具介绍
http://soartju.iteye.com/blog/564690 最近组内一直在做代码改进,既然是代码级别的改进,我想比较直接有效的办法就是Code Review. 虽然以前开发部也做过代码评 ...
代码审查（Code Review）的本质
什么是代码审查? 代码审查是一个过程,即代码只有经过非作者本人评审后才能进入代码仓库. 代码审查的目的但是大家为什么要做代码审查?不同团队的原因是各不相同的.笔者假设大家进行代码审查的目的是为了保证 ...

java 代码审查_代码审查（Code Review）清单

java 代码审查_代码审查（Code Review）清单相关推荐

最新文章

热门文章