软件构造笔记 4.1 Construction for Understandability

易理解性的度量

代码的可读性很重要：相比于写新代码来说，程序员大部分时间都用来阅读和修改已有代码。难以理解的代码会难以维护，可能隐含更多的错误。

为增强代码的易读性，应注意以下几点：

代码长度，度量方式为所有标识符的平均长度；命名独特比例；代码复杂度；代码行数；注释的密度。

经验:代码的可读性可理解性很多时候比效率性能更重要，不可读不可理解代码可能蕴含更多的错误。

先写出可读易懂的代码，再去逐渐调优!

注释

代码应该具有"自描述"，好的代码即使不加注释也容易读懂，否则增加注释，解释”解释为什么这样编码“。好的程序员在四个位置加入注释：

标题和介绍注释:用于描述整个文件，Java类，接口，构造函数，方法和字段。

块注释：用于提供文件，方法，数据结构和算法的描述。

单行评论：非常短的评论可以与他们描述的代码在同一行显示，但应该移动足够远以将它们与语句分开。

尾随评论：简短的评论可以出现在单行上，缩进到水平下面的代码。

结束行注释：//分隔符可以注释掉一个完整的线或只有部分线路。

评论是代码的一个组成部分

程序文档是代码的一个组成部分，而不是单独的。

- 标题和介绍性评论最好写在代码之前。那帮助你澄清你的想法，通常可以节省时间。

- 可以在代码之前，之中或之后写入逐行和块注释。在复杂的逻辑中，块注释常常用于解释当时数据项的状态。

评论应该避免说明代码中显而易见的内容。

- 描述正在做什么，而不是如何做。

- 评论不应提供可以从代码轻松推断的信息。

对于ADT的代码，以下所有内容均为强制性注释：

伪代码：用于表达某个模块/算法内部处理逻辑/流程。因为便于读写；可以解决逻辑上问题；用自然语言书写的优势而被广泛应用。

编码规范:定义了一系列的规则，按这些规则进行编码，有助于提升代码可读性，例如——命名、代码布局/缩进、数据声明方式、文件组织方式等。

代码约定对程序员来说很重要，原因如下：

- 一个软件的生命周期成本的80％用于维护。

- 几乎没有任何软件的原作者能够维持其整个生命周期。

- 代码约定提高了软件的可读性，使工程师能够更快更全面地了解新代码。

- 如果您将源代码作为产品发布，则需要确保它与您创建的任何其他产品一样好包装和清洁。