整洁的代码 清单项目 分类 使用可以表达实际意图(Intention-Revealing)的名称 有意义的名称 每一个概念只用一个词 有意义的名称 使用方案/问题领域名称 有意义的名称 类应该是比较小的! 类 函数应该是比较小的! 函数 只做一件事 函数 DRY(Don’t Repeat Yourself)原则,(拒绝重复) 函数 用代码来解释自己的做法(译者注:即代码注释) 注释 确定应用了代码格式化 格式 使用异常而不是返回码 异常 不要返回Null 异常 *参考自:http://techb…

http://www.cnblogs.com/IT-Bear/archive/2012/07/04/2576367.html…

CodeReview 是大型软件工程中公认的必不可少的保证工程质量的重要手段之一.但凡正规软件作战军团都是非常重视 CodeReview 的作用和意义的.那么,如何做好 CodeReview 呢?这里总结下自己的学习笔记和实践心得. CodeReview有效性 对于 CodeReview 该做什么和不该做什么,尚存在争议. 个人认为,与其从理论层次去思辨,不妨从现实角度思考:怎样的CodeReview是有效的? 如果一次CodeReview能够检测出代码中的错误或设计的缺陷(即使是低级错误),阻…

本文来自于腾讯Bugly公众号(weixinBugly),未经作者同意,请勿转载,原文地址:https://mp.weixin.qq.com/s/ToYeT4Y4pzx0ii9Z92fo-Q 作者:刘永丽 导语 精神哥最近和团队中的开发同学聊天,看到很多开发同学对代码技能的提升都是有诉求的,只不过快速的业务节奏没有给他们太多停留的时间,在这种情况下如何给团队营造浓厚的工程师交流氛围呢? 方法有多种,目前最被认可或运用的方法莫过于CodeReview活动了. 那么 CodeReview到底能给团队…

先说说我们公司现在的做法,一个团队被人为地分为两个阵营:Senior Developers和Junior Developers,比例差不多是1:1,Senior Developers就担负着对Junior Developers的代码进行Review的职责,每天Review一次,对有问题的代码写上comments,然后也check in到代码库中.这种comments有特殊格式(比如//\\CodeReview:blah blah),要求Junior Developers每天下班前一小时去代码库中…

目录 . 引言 . 代码检视的指导思想 . 代码检视的内容 . 回归测试 0. 引言 代码检视(Code Review)是指软件开发人员在完成代码设计.编写.调试后展开的个人或群体性的代码阅读过程,代码检视的目的是发现代码中的设计问题.格式问题.逻辑问题.语法问题等,从而保证代码的高质量交付.从软件工程的角度讲,在代码检视阶段发现代码问题的成本是低廉的,所以严格认真的执行代码检视过程,是提升产品质量,降低产品维护成本的有效手段 Relevant Link: http://www.distorag…

        代码质量分享    2016_06_24_舒琴_代码质量.key    For 代码提交人     基本原则 Review时机: 对于普通bugfix或优化,CodeReview最迟要在发布前一天或发布当天早上: 对于项目,CodeReview 最迟应该在QA提测前一天: 持续增强:     每次提交变更尽可能小一点, 但是保证每次的变更都是正确和完整的, 合并到代码库中持续增强系统. 去除无用改动: 仔细斟酌每一行改动,去掉无用的注释,reset 掉没有逻辑改动(空行改动)的文…

关于codereview,在平时的开发中,经常忽略的环节,参照目前介绍写好代码的几本书和之前掉进的坑,做了一个总结,分享出来. 为什么要做 通过review规避一些代码层面的问题 提升可读性,方便后续扩展和维护 double check 确保代码质量 检查列表 注释 写有意义的注释 DO属性上,名字无法识别业务含义的,加注释 service接口和manager接口,注明方法的说明 代码块中的复杂逻辑,添加注释 风格 域名不要写死 不同环境下差异的,注意使用配置项 日志 合理分配日志级别,warn…

自动化CodeReview系列目录 自动化CodeReview - ASP.NET Core依赖注入 自动化CodeReview - ASP.NET Core请求参数验证 参数验证实现 在做服务端开发时经常需要对客户端传入的参数进行合法性验证,在ASP.NET Core中通常会使用如下方式: public class LoginModel { [Required(ErrorMessage = "账号不能为空")] public string Account { get; set; }…

在软件项目开发中,我们经常提到一个词“code review”.code review中文翻译过来就是代码评审或复查,简而言之就是编码完成后由其他人通过阅读代码来检查代码的质量(可编译.可运行.可读.可维护.可复用),这些性质都比较抽象,但是一般都可以通过以下的检查点来实现: 检查代码的命名方式是否符合规范,代码的可读和可维护必须要求所有参与编码的同事使用的命名有统一的规范(注意每个人有自己的代码风格,但是要符合可读性的代码规范): 检查代码的注释,我认为注释至少包括:1.类要有类用途和使用事项…