我的代码审查清单

我喜欢代码审查。每次审查代码，我通常都能学到一些新的技巧或窍门。无论是专家编写的代码还是新手编写的代码，我都能从中学习。

做评测时很难面面俱到，所以这里列出我个人会检查的项目清单。

我的代码审查清单

• 拼写：正确拼写有助于其他人在调试、重构或编写增强功能时更有效地搜索代码。
• 文本转写：如果是内容更新，我会仔细核对原文。
• 链接：是相对链接？绝对链接？SSL 加密？正确答案取决于项目，但我总是会点击链接检查它们是否有效。
• 过于复杂的代码：我不喜欢代码高尔夫。编写过于优雅的代码只会让代码更脆弱，更难维护。如果我在凌晨三点遇到问题时都看不懂代码，我希望它被重构或编写详尽的文档。
• 它符合代码规范吗？我喜欢代码规范。如果每个人都知道要求是什么，代码就越容易被接受。换句话说，“先争论一次用制表符还是空格，然后团队一起决定，并把它写下来。”
• 注释：格式和长度取决于团队（参见代码规范）。有些团队更喜欢在提交信息或 README 文件中注释代码。这一步可以重命名为“代码是否复杂或混乱但有文档说明？”
• 安全性：此资源是否仅限管理员或编辑使用？如何进行权限控制？输入内容是否经过安全处理？

行动

• 运行代码检查器：有时候人们会忘记。
• 运行测试：是的，即使有自动化测试也需要运行。

测试

• 运行代码：更改生效了吗？
• 检查现有行为：此更改是否会影响其他无关事项？我通常只检查两到三个关键路径。

如果一切看起来都没问题，我就批准这个拉取请求。

代码审查不应该是一件苦差事，而应该是一个让每个人都受益匪浅的学习机会。