Tag: Code Review

我的代码检查清单

(由我们自己的Mobster Sameh Mabrouk ,高级iOS开发人员 @Mobiquity贡献 ) 代码审查的定义: 根据维基百科: 代码审查是计算机源代码的系统检查(有时称为同行审查)。 它旨在发现在初始开发阶段被忽略的错误,从而提高软件的整体质量。 好吧,我想这样做! 等等,但是…… 怎么做? 可以采用多种形式进行审核,例如配对编程,非正式演练和正式检查。 最有名的大概就是这个-给我看看您的代码(又名非正式评论)! 只需让您的同伴查看您的代码即可。 可以使用不同的工具(例如Atlassian的Crucible / Fisheye或BitBucket / GitHub上的拉取请求)或任何您使用的工具来执行正式代码审查。 借助这些工具,您可以很好地看到对源代码所做的更改,可以对它们进行注释,向作者提出一些问题,然后他们可以解释其代码。 就像您在现实生活中进行的对话一样,但是要记录在案–同意的内容应该在合并成开发之前执行。 等待,什么合并? 我们只是在谈论评论… Git流 在工作中开发应用程序的不同部分时,我们使用Git和Git Flow将所有更改合并到父分支中。 应用功能完成后,我们将创建一个请求请求,其中包含要添加到先前分支(通常是开发 )中的更改。 我认为,显示流程的最佳图片来自GitHub。 流程如下所示: 从开发创建分支 将您的更改应用于源代码 创建一个合并到例如开发中的拉取请求 与同事讨论变更,解释您的观点并应用建议的改进措施 您的同伴批准您的更改 将您的代码合并到源分支 进行审核时应该注意什么? 您绝对应该检查代码的完整性-样式是否与以前的解决方案匹配,是否遵循约定的约定? 功能是否正确实现(关于这一点,我会建议PR创建者是否可以添加.GIF图像来说明功能的工作原理,这样很好) ,更改后旧的源代码是否可以正常工作? 为什么要在开发过程中关心代码审查? 可以肯定的是,由于它确保代码完整性(),因此可以捕捉到其他人看不到的东西。 它可以让您学习和分享您的知识和专长,通过与您共同的话题(代码和编程技能;)的对话,加强团队中的沟通并建立良好的关系;)! 就我个人而言,最近在我当前的项目中已经看到了。 团队在沟通方面存在问题,但是在我们进行了代码审查的对话之后,沟通变得更好了。 将代码审查视为对未来的投资。 如果您现在不捕获错误,那么将来一定要征服它们。 如果您不执行代码审查该怎么办 想象一家X公司,它为多个客户提供移动应用解决方案。 他们的团队很小,有时甚至无法满足客户的需求。 因此,他们决定将一些工作外包给外部公司。 他们向该公司提出项目要求,并在3个月后再次开会以接收应用程序源代码。 但是该应用程序无用,它在网络调用时冻结, […]