|
Post by account_disabled on Dec 31, 2023 3:39:20 GMT
然后将类划分为更小的更详细的子类审查代码以减少不必要的行或使用更现代的技术并在变量命名或注释上留下注释直到最后。 请记住代码审查可能包含多次迭代因为新版本的代码可能需要进步审查。 保持积极的氛围也很重要 提出问题比下达命令或强制更改代码更好。你如何评论代码通常比你说什么更重要。要有礼貌尊重代码作者并在提出更改时提供具体示例。不要写 这很糟糕请更改它 而是写 考虑将此组件分离为单独的函数如以下代码所示 代码示例 或 您对分离此组件有何看法 代码审查期间的。 变更提案示例 代码审查期间的变更提案示例 避免直接联系代码作者也是个很好的做法。与其指责同事犯了错误不如使用客观的形式或使用 我们 作为陈述的主语。如果您建议更改代码或采用全新的方法请解释您的决定的原因 提供基于规则或标准的指南而不是您自己的意见。您的示例应基 C级联系人列表 于文档 上高评价的答案或来自受人尊敬的博客的内容。另外避免在同个 中重复评论相同的错误。 代码审查应该基于合作和客观讨论而不是判断。这就是为什么在 我们总是评论是出于善意。 如果我们不理解某段代码请向作者寻求澄清。在评论您认为不直观的代码时您的评论应该是主观的例如 我很难理解这部分的内容 而不是 这令人困惑 以免让其他查看者感到困惑公关。 如果您是审阅者请记住激励开发人员分享积极的评论并在代码好的时候表达赞赏。代码审查对于作者和审阅者来说都是个学习机会因此作为作者请保持开放的心态并对审阅者表示感谢。不要指望第次 后质量会大幅提高有些更改需要更多时间。 代码审查的优点 代码审查最重要的优点是提高代码的运行和质量消除错误并避免损坏的构建。
|
|