摘要: 好代码、坏代码之二4.多注释,少废话代码,一定是给人看的,而代码本身的逻辑又决定于方法、类型和依赖的关系之中,所以,必要的注释,是必需且必要的。通过注释的进一步解释,来辅助性地告知代码的逻辑、算法或者流程,不仅是好习惯,更是好代码。另一方面,注释不是“无病呻吟”,没有必要表述那些显而易见的逻辑或者说明,同时注意区分单行注释和多行注释的应用。在.NET平台下,XML格式的注释还肩负了另一项重要的使命,那就是根据注释生成代码文档。例如:///<summary>///根据用户信息,构建标签信息///</summary>///<paramname="member 阅读全文
posted @ 2011-08-11 16:50 我的javaIT 阅读(214) 评论(0) 推荐(0) 编辑
摘要: 好代码、坏代码之一1.命名很重要,让代码告诉你它自己命名到底有多重要呢?重要到这几乎是很多软件项目成功或者失败的“罪魁祸首”,究其原因,代码不光支撑了0和1在计算机系统中运行的业务逻辑,同时也是开发者进行交流与研究的标准语言。没有意义或者有歧义的命名,就像两个等待交流的人,面对了一堆火星文无从下口,让交流变成灾难,也就导致很多问题。同时,好的命名是自说明的,让代码告诉开发者“我是谁,我做什么,我怎么做”。当然,除了静态式的必要的注释说明之外,动态式的代码也可以包含传递信息的作用,让代码告诉你它自己,因为代码是“活的代码”。例如,以某个缓存容器为例,泛型参数明确了容器的Key和Value的关系, 阅读全文
posted @ 2011-08-11 16:43 我的javaIT 阅读(215) 评论(0) 推荐(0) 编辑