cms网站,官方网站包括哪几个网站,组织建设方面存在的问题,山东省工程建设信息官方网站当你审查别人的代码时#xff0c;你会寻找什么#xff1f; 无论你是通过像 Upsource 这样的工具来审查代码#xff0c;还是在同事讲解他们代码的过程中进行审查#xff0c;在任何情况下#xff0c;有些事情都比其他事情更容易评论。比如#xff1a; 格式#xff1a;空…当你审查别人的代码时你会寻找什么 无论你是通过像 Upsource 这样的工具来审查代码还是在同事讲解他们代码的过程中进行审查在任何情况下有些事情都比其他事情更容易评论。比如 格式空格和换行符在哪里他们是否使用制表符或空格大括号是如何布局的样式变量/参数是否声明为最终变量/参数方法变量是在使用它们的代码附近还是在方法的开头定义的命名字段/常量/变量/参数/类名是否符合标准名字是不是太短了测试覆盖率是否有针对此代码的测试 这些都是需要检查的有效事项——您想要最小化不同代码区域之间的上下文切换并减少认知负载因此您的代码看起来越一致就越好。 然而让人类寻找这些可能不是组织中时间和资源的最佳利用因为其中许多检查可以自动化。有很多工具可以确保代码的格式一致遵循有关命名和最终关键字使用的标准并发现由简单编程错误引起的常见错误。例如您可以运行 IntelliJ IDEA 从命令行进行检查因此您不必依赖所有团队成员在其 IDE 中运行相同的检查。 你应该寻找什么 人类真正擅长什么样的事情在代码审查中我们能发现哪些我们无法委托给工具的东西 事实证明有数量惊人的东西。这当然不是一个详尽的清单我们也不会在这里详细讨论其中任何一个。相反这应该是你的组织中关于你目前在代码审查中寻找哪些东西以及你应该寻找什么的对话的开始。 设计 新代码如何与整体架构相适应代码是否遵循 SOLID 原则、领域驱动设计和/或团队喜欢的其他设计范式新代码中使用了哪些设计模式这些合适吗如果代码库混合了标准或设计风格那么这些新代码是否遵循当前的做法代码是朝着正确的方向迁移还是遵循即将被淘汰的旧代码的示例代码是否在正确的位置例如如果代码与订单相关它是否在订单服务中新代码能否重用现有代码中的某些内容新代码是否提供了我们可以在现有代码中重用的内容新代码是否引入了重复如果是这样是否应该将其重构为更可重用的模式或者这在现阶段是否可以接受代码是否过度设计它是否为现在不需要的可重用性而构建团队如何平衡 YAGNI 的可重用性考虑因素 可读性和可维护性 字段、变量、参数、方法和类的名称是否真正反映了它们所代表的事物我可以通过阅读代码来理解代码的作用吗我能理解测试的作用吗这些测试是否涵盖了一个很好的 case 子集它们是否涵盖快乐的道路和特殊情况有没有考虑过的情况异常错误消息是否可理解令人困惑的代码部分是否被记录、注释或被可理解的测试所覆盖根据团队偏好 功能性 代码真的做了它应该做的事情吗如果有自动化测试来确保代码的正确性那么这些测试是否真的测试了代码是否满足了约定的要求代码看起来是否包含细微的错误例如使用错误的变量进行检查或者不小心使用了 and 而不是 or 你有没有想过...... 代码是否存在潜在的安全问题是否有需要满足的监管要求对于自动化性能测试未涵盖的领域新代码是否引入了可避免的性能问题例如对数据库或远程服务的不必要调用作者是否需要创建公共文档或更改现有帮助文件是否检查了面向用户的消息的正确性是否存在明显的错误会阻止它在生产中工作代码是否会意外指向测试数据库或者是否存在应该换成真实服务的硬编码存根