首页 诗词 字典 板报 句子 名言 友答 励志 学校 网站地图
当前位置: 首页 > 教程频道 > 开发语言 > 编程 >

编纂可读代码的艺术-从命名和注释开始

2013-01-18 
编写可读代码的艺术-从命名和注释开始什么样的代码才是真正好的、整洁的代码?iteye.com上的文章很多: Grady

编写可读代码的艺术-从命名和注释开始

什么样的代码才是真正好的、整洁的代码?iteye.com上的文章很多:
Grady Booch,《面向对象分析与设计》作者:
引用
??? ? 整洁的代码是简单、直接的;
??? ? 整洁的代码,读起来像是一篇写得很好的散文;
??? ? 整洁的代码永远不会掩盖设计者的意图,而是具有少量的抽象和清晰的控制行。
Dave Thomas,OTI公司创始人,Eclipse战略教父:
引用
??? ? 整洁的代码可以被除了原作者之外的其他开发者阅读和改善;
??? ? 具备单元测试和验收测试;
??? ? 有一个有意义的名字;
??? ? 使用一种方式来做一件事情;
??? ? 最少的依赖,并明确定义;
??? ? 提供了一个清晰的、最小的API;
??? ? 应该根据语言特性,在代码中单独显示必要的信息,而不是所有的信息。
??? ?
从他们的归纳中,可以看出真正好的代码都有一个共性,可读性。在《编写可读代码的艺术》这本书中,作者是这样定义可读性的:“代码的写法应当使用别人理解所需的时间最小化”。在这本书的指导下,从命名和注释开始在自己这几年写的代码中找出一些例子。希望自己以后在这些细节上引以为戒。
一.把信息封装到名字中,无论是类,方法或变量的命名

??? 1.选择专业的词,尽量避免模糊或意义太广

?

??? 若改为:

?

??? 7.与使用者的期望相匹配
??? ??? 方法的名称要符合用户的期望,我们通常期望get()方法是轻量的方法。

        /**         * The load factor used when none specified in constructor.         */        static final float DEFAULT_LOAD_FACTOR = 0.75f;
?


???
??? 3.站在读者的立场上思考。

???? 为普通读者意料之外的行为加上注释,用注释来总结代码块或精确地描述函数的行为,使读者不致迷失在细节中。

三.细节决定成败,表面并非肤浅
??? 对于上面的每一个细节如果都能做的很好,这就为写好代码,写好可读代码,写好整洁代码迈出了第一步。

参考资料:《编写可读代码的艺术》

热点排行