目的
目的
代碼功能 代碼質量 軟件結構,可維護性
做法
kpi,每個team每幾個月要做一次team內部的sharing,要有ppt
checklist
代碼是否清晰的表達了他的意圖 代碼是否對邊界情況做了error handling 代碼是否封裝好內部狀態,讓外部不能直接訪問內部? 比如:大段代码、大函数、大类、长SQL、复杂存储过程、使用频率高的功能、代码嵌套太深、核心算法实现、核心接口实现、函数参数过多、用户输入校验是否有安全隐患、异常处理、日志记录、业务是否需要事物等等太多了。 https://jimmysong.io/eng-practices/docs/review/ 代码审查时应该关注以下方面:
设计:代码是否经过精心设计并适合您的系统? 功能:代码的行为是否与作者的意图相同?代码是否可以正常响应用户的行为? 复杂度:代码能更简单吗?将来其他开发人员能轻松理解并使用此代码吗? 测试:代码是否具有正确且设计良好的自动化测试? 命名:开发人员是否为变量、类、方法等选择了明确的名称? 注释:注释是否清晰有用? 风格:代码是否遵守了风格指南? 文档:开发人员是否同时更新了相关文档?