Google的工程实践文档.docx

Google的工程实践文档
前言最近读了《Google的工程实践文档》，收获颇丰，在此做个记录。开头附上原文与 中文地址：
英文原文: s://github /google/cng-practiccs中文翻译:
这份文档是Google的工程实践文档
前言最近读了《Google的工程实践文档》，收获颇丰，在此做个记录。开头附上原文与 中文地址：
英文原文: s://github /google/cng-practiccs中文翻译:
这份文档是Google code review的流程和规范，告诉大家该如何做好code review与提交code review。文档中有很多点我觉得很好，所以精炼出来方便以 后自己重新阅读，如果未看过原文最好读下原文。
明确code review的目的code review最主要的目的是保证代码库中的代码质量持续改进，确保提交至代码库中 的代码有利于代码库的质量、可维护性与可读性；code review另外一个目的是能让开 发者学到新知识，无论是开发语言、框架、软件设计原那么，如果reviewer觉得某些评 论能够帮助开发者学到新知识就应该毫不犹豫写下来，因为提供知识是提高代码质量 的一种方式。
如何成为更好的reviewer保持礼貌与尊重，让开发者明白尽管我不同意你的观点，但是我很尊重你，因为不礼 貌的交流或评论容易让开发者烦躁与抱怨，这不利于工作与交流。
世界上没有完美的代码，只有更好的代码，一般来说如果开发者提交的代码能显著提 高代码库的质量，即使有不完美的地方reviewer也应该通过，不应该追求代码每一个 细节都做到完美，应该做好修改时间年修改重要性之间的平衡。
code review的标准不应由reviewer的主观喜好决定，代码样式应该遵循团队统一的风 格，软件设计应该遵循基本或团队统一的设计原那么，当没有可参考的标准时应该保持 与现有代码库一致，因为这样至少不会恶化代码的质量。
了解代码背后的需求或功能背景，考虑代码的功能实现是否正确、设计是否合理、是 否存在过度设计而导致的复杂化。
读懂每行代码，如果没读懂可以要求开发者解释清楚，这么做有助于帮助以后的工程 师，让他们读到这段代码时更容易理解。
表扬开发者代码中较好的方面，reviewei■不应该只关注代码中的错误，因为有时候告 诉他们哪方面做得好比哪方面做的缺乏更有价值。
保证对code review流程的快速响应，而并非快速完成code review过程。
解释code review中的评论，阐述自己的意图或者自己遵循的最正确实践°指出代码中的问题，作为reviewer有责任为开发者提供简单的指导或建议来帮助开发 者做得更好。
接受开发者的解释，保持与开发者进行沟通的意愿，愿意与开发者进行平等沟通而非 对其发出命令，因为开发者往往对代码更了解，开发者如果是对的应该果断告诉他