一个典型的代码走查检查单
发布于 2024-10-04
1194
版权声明
我们非常重视原创文章,为尊重知识产权并避免潜在的版权问题,我们在此提供文章的摘要供您初步了解。如果您想要查阅更为详尽的内容,访问作者的公众号页面获取完整文章。
麦哲思科技任甲林
扫码关注公众号
扫码阅读
手机扫码阅读
Code Review Checklist Summary
The primary goal of code review is to identify logical errors within the program, while programming style issues can be checked using style checking tools. The provided checklist is a valuable aid for code review experts to spot such logical errors.
Checklist Items
- Are the code comments consistent with the code itself, and are they necessary?
- Does the code have loops and/or conditions nested more than 3 levels deep?
- Do variable names accurately represent their function?
- Are all loop boundaries correct?
- Are all condition boundaries correct?
- Is there proper handling for exceptional cases of input parameters?
- Are all exceptions within the program handled?
- Does the code contain any duplications?
- Are there methods exceeding 20 lines of code?
- Are there classes containing more than 7 methods?
- Do methods have more than 3 parameters?
- Are there multiple reasons for modifying a class?
- Does a functional change require modifications in multiple classes?
- Are the constants used in the code appropriate?
- Does a method access multiple attributes from other classes?
- Do certain data items always appear together, yet they are not part of a class?
- Can switch statements be replaced by classes?
- Are there classes with very few responsibilities?
- Are there unused attributes or methods in a class?
- Does the code have method calls in the form of a.b().c() within class methods?
- Does a class method always call another class's method with the same name?
- Does a class consistently access another class's attributes and methods?
- Do two classes perform similar tasks with different method names without sharing a common parent class?
- Is a class composed only of fields and simple get/set methods?
- Does a subclass only use some of the parent class's attributes or methods?
麦哲思科技任甲林
麦哲思科技任甲林
扫码关注公众号
麦哲思科技(北京)有限公司总经理 敏捷性能合弄模型评估师 认证的Scrum Master 认证的大规模敏捷顾问SPC CMMI高成熟度主任评估师 COSMIC MPC,IAC 成员,中国分部主席
471 篇文章
浏览 814.2K
还在用多套工具管项目?
一个平台搞定产品、项目、质量与效能,告别整合之苦,实现全流程闭环。
查看方案
麦哲思科技任甲林的其他文章
产品的内部质量与外部质量
质量是我们天天挂在嘴边的词,质量的真正含义到底是什么?不同的标准中有不同的定义。我们不去讨论其严格的定义,换一种角度来看产品的质量。 产品的质量可以划分为外部质量与内部质量。外部质量是用户可见、用户可以体验到的质量,比如你新买了一辆车,你可以感受到车的外观、车提速的快慢等,这是车的外部质量;再如我们买了新房子,我们可以看到房子的地面是否水平、墙皮是否脱落等。内部质量是用户难以看到、难
需求与设计人员如何配合工作?
在软件开发的过程中 ,经常出现需求与设计脱节的现象,如设计人员按照自己的理解去设计,没有遵从需求去设计系统;需求人员做完需求定义后,交给设计人员去设计,撒手不管了等等,为了使需求与设计人员更好的协作,建议采取如下的措施:Ø 需求人员与设计人员一定要分离,否则无法解决需求文档化的问题,但是文档并不能解决所有的沟通的问题,还需要面对面的沟通。Ø 需求评审设计人员一定要参加,设计评审需求
快速学习COSMIC方法之十二:如何识别输出?
输出是从功能处理向功能用户移动数据组的数据移动。每个输出移动的是一个兴趣对象的一个数据组。在识别输出时要注意如下的问题:1 输出不要和写混淆。输出是把数据组移动到功能用户,不是移动到存储介质。虽然识别错了数据移动的类型不影响功能点的多少,但是概念上是错误的。2 查询固定文本的内容应识别为输出。比如在word中有按钮:关于word。当我们点击后,显示出来关于word的一些信息,这些信息就是一个固定文...
LLM赋能自动化编程后的软件管理体系重构
文章浏览阅读464次,点赞10次,收藏5次。摘要:随着企业采用LLM实现代码自动化生成,传统的软件过程管理体系需重构为AI原生体系(AI-NativePMS)。新体系以提示词工程为核心,聚焦Prompt输入管理和AI输出验证,实现从"编码审查"到"Prompt审查+强验证"的转变。关键变革包括:需求阶段Prompt工程化、架构设计契约优先、开发流程四重自动化门禁、测试左移与AI验证体系,以及新增Prompt版本管理等原生过程。配套四大制度保障规模化应用,岗位职责重构为Prompt工程师等新角色,并建立生成
做事模式的思考:想、说、写、做
模式一:边做边想没有事先的计划,没有思虑周全,在做的过程中再去寻找好的方法,造成的后果就是质量差或返工多,浪费了时间。很多初级的开发人员在编码时就采用了这种工作模式。磨刀不误砍柴工,先想清楚,再动手做,看似慢,实际快!模式二:想->做 想清楚了总比不想好。此种模式没有和别人沟通,没有文档化,这种模式很可能想的不周全,导致在做的过程中存在问题。三思而后行,如何保证三思的质量呢?沟通与文档化。模式三:想->写->做 想了以后文档化,文档化可以促进自我反思,但是没有其他人进行评审,然后去实现,没有其
加入社区微信群
与行业大咖零距离交流学习
PMO实践白皮书
白皮书上线
白皮书上线