Google的工程实践文档
hello,小伙伴们大家好,今天给大家推荐的项目是:Google的工程实践文档
。
这份文档积累自 Google 团队长期以来的内部项目最佳实践,其目的在于帮助开发者更好的做好代码审查工作,通过 Code Review 来提升并优化当前项目的代码质量,也便于后续开发人员的维护与管理。
Google 有许多通用工程实践,几乎涵盖所有语言和项目。此文档为长期积累的最佳实践,是集体经验的结晶。我们尽可能地将其公之于众,您的组织和开源项目也会从中受益。
开发者代码审查指南
简介
代码审查是除了代码作者之外,其他人检查代码的过程。
Google 通过 Code Review 来维护代码和产品质量。
此文档是 Google Code Review 流程和政策的规范说明。
此页面是我们进行 Code Review 流程的概述。本指南还有另外两套文档:
- 如何进行 Code Review:针对代码审查者的详细指南。
- 代码开发者指南:针对 CL 开发者的的详细指南。
代码审查者应该关注哪些方面?
代码审查时应该关注以下方面:
- 设计:代码是否经过精心设计并适合您的系统?
- 功能:代码的行为是否与作者的意图相同?代码是否可以正常响应用户的行为?
- 复杂度:代码能更简单吗?将来其他开发人员能轻松理解并使用此代码吗?
- 测试:代码是否具有正确且设计良好的自动化测试?
- 命名:开发人员是否为变量、类、方法等选择了明确的名称?
- 注释:评论是否清晰有用?
- 风格:代码是否遵守了风格指南?
- 文档:开发人员是否同时更新了相关文档?
- 中文文档:https://jimmysong.io/eng-practices/
- Google 开源项目风格指南:https://github.com/zh-google-styleguide/zh-google-styleguide
- 开源地址:https://github.com/google/eng-practices
- 其他语言的版本请访问 https://github.com/eng-practices/eng-practices
今天的推荐不知道大家喜欢吗?如果你们喜欢话,请在文章底部留言或点赞,以表示对我的支持,你们的留言,点赞,转发关注是我持续更新的动力哦!
关注公众号回复:"1024
",免费领取一大波学习资源,先到先得哦!