不知不觉中,国庆节已经过去了一半以上。昨天我读了Google最近发表的有关CodeReview的文章,该文章是如何与CodeReview共享的。
design
在执行CodeReview时,最重要的是看一下整体设计的变化。
我们需要列出代码更改列表,以查看每个更改是否有意义以及每个更改是否有效。
进行更改的位置,逻辑层,服务层或存储层。
此代码不适合在此处更改,可以将其放在更合适的位置。
Features
在进行代码审查时,我们需要考虑一下这些更改是否真正使功能真正实现,并且这些更改是否友好且易于维护。
同时,我们应确保新功能正常运行。我们需要考虑业务是否具有边界情景。我们需要考虑是否存在并发问题,并确保代码中没有错误。
当我们的代码更改设计以更改UI时,我们可能很难看到新页面从代码。目前,我们需要向发起代码更改的人员提供一个演示,或提供UI出现的路径,以便我们可以
see。
代码的问题很难从代码中看出。从代码中很难看出是否存在死锁或并发冲突。同时,这些并发问题不仅仅是查找要运行的程序,我们需要
代码审查者进行更深入的思考,同时,开发同学也擅长避免使用并发模块问题。
复杂度
我们需要查看每个代码更改是否过于复杂。方法可能太复杂,或者类太复杂。认为其他人很难阅读此代码且难以维护很难理解。
这意味着其他人可以很容易地更改代码。
我们经常对代码进行过度设计,开发人员经常在代码中添加不必要的方法,代码审阅者需要对过度设计保持警惕,从而允许当前的开发人员以更简单的方式实施。
测试用例
在某些外国公司中,测试用例也需要进行代码审查。我们应该注意,每个测试用例都是有用的,正确的,并且可以涵盖代码的所有情况。
测试代码也经常需要维护,以使不同的场景变成不同的方法,不要使测试代码太复杂,以后很难维护。
name
需要代码审查的程序员必须知道代码的命名,无论是方法,变量还是类。如果命名难以理解或引起混淆,则应更正该命名。
Comment
#代码开发人员应在代码没有清楚说明意图时写下注释。
此注释将解释为什么以此方式编写此代码。
代码审阅者应注意,代码中的注释与代码的含义一致。
还要确保删除所有TODO注释。 ## style
像Google这样的公司都有自己的世代
代码样式,应遵循此样式。
如果您的某些代码不遵循这种风格,则最好对原因进行注释。如果要格式化文件,则应将格式文件与代码更改分开,并要求提供两个不同的CodeReview表。
请仔细阅读每一行代码
仔细阅读每一行代码,尤其是文件读写,大数据和类初始化。这些昂贵的代码应保持警惕。
Don \\ u0027t只是在粗糙的地雷中读取了函数名称,感觉到调用链接是正确的,而无需读取每一行代码。
审阅程序员需要了解每一行代码的作用。
也许您会认为代码审阅是浪费时间,并且非常困难。
但是,Google招聘的每个软件开发人员都非常出色。如果您可以这样做,那么您的能力可能不符合公司的要求。
other
如果在阅读代码时看到了不错的代码,则应该欣赏它。代码审查不是发现其他人的错误,而是改善自己的地方。