`

Code Review小结

阅读更多

前段时间针对团队敏捷模式下开展的项目工程代码进行了几轮的Code Review,下面是梳理的若干应该注意的条目:

1. 方法的命名不规范,应坚持使用驼峰形式,标准英文名称拼接,阿里标准:禁止使用下划线和$作为命名的开头和结尾,不能使用拼音和英文拼接的形式命名,除了一些国际公认的名称比如:taobao或hangzhou。
2. 发送http请求没有设置超时限制,建立设置请求超时时间并做额外的处理。
3. 前人代码中存在历史命名或代码不规范的地方,由于涉及面广,最好不做修改,知道有问题即可,自己在做改造时切忌遵守阿里代码规范,除非团队排计划进行代码规范的修改或重构,不然自身处理耗时太久,效率过低。
4. 没有对某一块的代码逻辑进行模块化的封装,现象是方法中实现的逻辑事务太多,应该把每一快逻辑单独封装成员一个方法,然后提出来公用。
5. 对于非空判断要注意逻辑性,去除掉一些不必要的非空判断。
6. 避免在for循环体内取一些数组或者列表的count,这样每循环一次就需要调用一次,可以先把容器大小的获取放在for循环外完成,到了for循环体中直接使用,可减少调用次数。
7. 对于一些没有事务性处理的代码逻辑片段,需要在失败之后记录日志,这样可以追溯具体的操作现场的一些信息,方便追溯和排查问题。
8. 在for循环中使用的对象,为了避免重复创建,无端占用过多内存,可以在for循环之前就创建好,然后在for循环中直接使用。
9. 如果某代码块中涉及到很多的if...else...判断,则可以从面向对象的角度考虑将这块判断逻辑单独提出封装为一个方法,这样大大增强了代码结构的优良性、易维护性和可读性。
10. 对于代码中出现的硬编码,即写死的常量或变量赋值等,都可考虑进行统一配置和维护,比如平台所有的http请求超时响应时间可以统一成配置项。
11. 有时copy别处的代码,要注意删除不必要的逻辑,不可完全照搬。
12. 对于遇到访问失败或报错等情况,页面应该给出增强用户体验的友好提示,比如网络错误等等,而不该直接给予一个“404”报警。
13. 如果页面方法全都封装到外部JS对象中,建议新增的方法也要统一按照这样的约定或标准做,也封装到JS对象中,方便后期维护和查找。
14. 对于逻辑判断较多的地方,建议单独提出来封装成方法,返回true或false,增强可读性和易维护性,也方便扩展到其他地方可用。
15. 有些加密key作为常量字符串应该提出来作为类的成员变量,并调取配置项进行赋值,而不应该直接在代码中赋值。
 
未完待续......
0
0
分享到:
评论

相关推荐

    Source Insight CodeReview宏,增加使用说明

    **Source Insight CodeReview宏**是专门针对Source Insight这款强大的源代码查看和编辑工具设计的一套扩展功能,主要用于代码评审和统计。Source Insight以其强大的代码导航、语法高亮和实时分析能力,深受程序员...

    Modern Code Review- A Case Study at Google.pdf

    Employing lightweight, tool-based code review of code changes (aka modern code review) has become the norm for a wide variety of open-source and industrial systems. In this paper, we make an ...

    CodeReview工具

    Code Review是软件开发过程中的一个重要环节,它有助于提高代码质量,发现潜在的错误,以及确保团队成员间的代码风格一致。本文将详细介绍两款Eclipse插件——Jupiter和Reviewclipse,它们是进行Code Review的有力...

    CodeReview工具Jupiter

    Code Review的作用和意义已在很多技术团队内达成共识,可是很多时候并未被有效执行,甚至被认为是一项费时费力的工作。借助一些工具可以更容易,更有效率地来进行Code Review,本文介绍的Jupiter即是其中之一。  ...

    Source Insight 宏 codeReview.em

    CodeReview工具的作用:1.减少评审人的缺陷记录和汇总时间,方便责任人查找问题出处;2.检视完成后生成检查报告,代码作者点击按钮可以直接找到错误处;3.任务责任人修改完成后,直接修改问题状态,组织者按快捷键...

    IDEA代码检视插件Code Review Helper(支持团队协同)

    在实际使用中,下载的压缩包文件"IntellijIDEA-CodeReview-Plugin-master"包含了插件的源代码,开发者可以对其进行定制或扩展以满足特定团队的需求。安装插件通常包括以下几个步骤: 1. 解压下载的压缩包。 2. 打开...

    代码审查CodeReview的最佳实践

    我一直认为CodeReview(代码审查)是软件开发中的最佳实践之一,可以有效提高整体代码质量,及时发现代码中可能存在的问题。包括像Google、微软这些公司,CodeReview都是基本要求,代 我一直认为CodeReview(代码...

    Redmine插件Code Review使用介绍

    在Redmine中,Code Review插件是一个重要的扩展,它致力于帮助开发团队进行代码审查,提升代码质量和团队协作效率。本文将详细介绍如何使用Redmine的Code Review插件。 首先,安装Code Review插件是必要的步骤。...

    静态测试方法之代码审查(CodeReview)的清单

    静态测试方法之代码审查(CodeReview)的清单。代码审查可以帮助提高代码质量,避免由于代码习惯而造成的bug。下面列出的这些要点因该可以作为大部分代码审查的指导,如果是Java应用的话,这些建议应该被视作最佳实践...

    PHP-Code-review.rar_PHP codereview_php code review_php代码review

    代码审核,是对应用程序源代码进行系统性检查的工作。它的目的是为了找到并且修复应 用程序在开发阶段存在的一些漏洞或者程序逻辑错误,避免程序漏洞被非法利用给企业带来不必 要的风险。

    C++ Code Review检查清单

    C++代码 Code Review时使用的检查清单和问题记录模板

    CodeReview.em

    source insighet 集成code review,代码审核时非常好用,使用起来比较简单,加入工程,同步,添加快捷键,使用快捷键即可正常使用,保存即可。

    CodeReview常見代碼問題

    ### CodeReview中的常见代码问题分析 #### 一、引言 在软件开发过程中,CodeReview(代码审查)是一项至关重要的活动。它不仅有助于提高代码质量,还能促进团队成员之间的知识共享和技术交流。本文将深入探讨Code...

    Steven Code Review 代码在线审查

    Steven Code Review 2009.12M1发布包.rar 代码在线审查工具 @date: 2009-12-28 @author: YF @email: yifi@tom.com 功能: 1 方便学员学习教师的代码,无需在本机运行IDE即可以代码加亮的方式查看服务器共享的代码...

    code review

    `CodeReview.em`可能是一个包含了代码审查过程记录或结果的文件,而`codereivew.docx`可能是详细的代码审查报告,其中可能详细列出了审查过程中发现的问题、建议的修改以及后续的行动计划。通过这两个文件,团队成员...

    漫谈codereview

    漫谈codereview,关于review的一些基础知识和总结。

    zyh-code-review.rar

    zyh-code-review.rarzyh-code-review.rarzyh-code-review.rarzyh-code-review.rar

    Codereview 代码审查工具(国人开发)

    软件介绍: 一、软件特色 功能丰富:实现文件内容、度量、命名、注释、类图、Halstead等审查。 简单易用:无需安装,直接使用,直接删除;... 直观可视:分析结果与源代码在同一界面显示对照,...http://www.codereview.com.cn

    code review tool from google

    标题:Code Review Tool from Google 描述:Code review on the web 根据给定的文件信息,我们可以提炼出关于代码审查(Code Review)及其在谷歌开发流程中的应用的关键知识点。 ### 什么是代码审查? 代码审查...

Global site tag (gtag.js) - Google Analytics