【导读】假如 说修建 师最初 的制品 是修建 的话，那末 法式 员和软件工程师终究 的制品 就是软件。在实践 开工 之前，修建 师将会将修建 的每个 细节，都在蓝图上加以出现 。只是法式 员和软件工程师其实不 会这么做。也许 ，这就是为何 房子很少倾圮 ，而软件却常常 溃散 的缘由 ?

　　写代码和写文章，从某种水平 上是相通的，需求 逻辑、构架，也要尽量 的简洁 。咱们 之前说过，创作者的工夫 表和办理 者的工夫 表是纷歧 样的，编代码和写文章，都是一个伶仃 而不克不及 遭到 搅扰 的进程 ，面临 屏幕，就是一场本人 与本人 的和平 。

　　一样 ，假如 说修建 师最初 的制品 是修建 的话，那末 法式 员和软件工程师终究 的制品 就是软件。在实践 开工 之前，修建 师将会将修建 的每个 细节，都在蓝图上加以出现 。只是法式 员和软件工程师其实不 会这么做。也许 ，这就是为何 房子很少倾圮 ，而软件却常常 溃散 的缘由 ?

　　设计蓝图会匡助 修建 师肯定 他们的设计是可行的。“可行”并不是 只是包管 不倾圮 ，它同时还意味着，修建 可以 到达 预定的办事 于人的方针 。客户或 开辟 商，也是经由过程 蓝图去懂得 一个设计师的设法 和他正盘算 去做的工作 。

　　相较之下，很少有法式 员会在他们入手下手 写代码之前，连一个粗略的框架都没有。

　　大局部 的法式 员都以为 ：一切 不克不及 直接产出代码的工作 都是没成心 义的。思虑 其实不 能直接转换成代码，然而 倘使 在没有一个全体 框架之前，就入手下手 急忙 码字，这也是没成心 义的。在法式 员入手下手 写代码之前，他们应当 先充实 了解 这些代码终究 所要完成 的功效 。了解 的进程 ，天然 需求 去思虑 ，而将思虑 进程 写上去 ，关于 法式 员来讲 又是件很耗时的事儿。

　　但漫画家 Dick Guindon 已经 所过：

　　写作是发明 你设法 有多糟 最好的体例 。

　　蓝图匡助 咱们 了解 修建 的构架，一样 ，在咱们 入手下手 噼里啪啦写代码之前，咱们 也需求 一个相似 的“蓝图”，也就是“正文 ”(specification)。

　　“正文 ”不克不及 直接产出代码，所以被良多 法式 员无视 。但没有“正文 ”，直接开写，就仿佛 让修建 承包商没有设计师的图纸就直接上阵一样。

　　也有人会说，将法式 员和修建 师类比，其实不 公道 。由于 拆墙重建坚苦 ，但删失落 重写则绝对 轻易 ，所以，法式 员可以先写着，不写意 再改。

　　这类 设法 是错的。为何 呢?由于 Debug 的进程 也十分 耗时。

　　我比来 也完美 了一些法式 ，这个进程 需求 对法式 构架自己 有个十分 明晰 的懂得 。我花了接近一天的工夫 去懂得 全部 法式 的运作机制，而倘使 有正文 的话，这能够 只需求 5 分钟的工夫 。

　　为了不 引入 bug，我需求 了解 任何小的调剂 能够 带来的了局 。而没有正文 ，使得我必需 花很长工夫 懂得 每条代码的寄义 和感化 。特别 关于 上千行的代码来讲 ，起首 读懂它就很耗时，想要改失落 个中 的某行，我必需 懂得 小的调剂 能够 对全体 架构和前后逻辑酿成的 影响。终究 ，在超越 一个礼拜 的工夫 里我只改了 180 行代码，而这对一个动辄千行的法式 来讲 ，改动 算是很小的了。

　　Debug 只是写代码一个小的构成 局部 。这数千行的代码良多 我 10 年前写的，虽然 我对它们仍有些许残余 的记忆，但假如 有正文 的话，修正 代码的进程 会加倍 顺畅，我不但 能在最短的工夫 里读懂全部 框架，还可以正确 定位我所要修正 的局部 。

　　改他人 的代码就加倍 坚苦 了，每一个 人的思惟 体例 都纷歧 样，假如 没有正文 ，我凡是 要消费 两倍以上的工夫 ，只是为了修正 一些渺小 的毛病 。

　　那末 ，我所谓的“正文 ”又是指甚么 呢?“正文 ”是指附在代码以后 的，一段模式 化标准 申明 的文字。但需求 辨别 开的是，假如 只是去打造一个东西 室，咱们 是不需求 一整套摩天大楼蓝图的，一样 ，关于 小的算法来讲 ，咱们 也不需求 给每条代码加上注解。

　　我比来 要编写的法式 ，最多称得上是“平房”，而非摩天大楼。我会为我的每一个 算法附上正文 ，有些十分 复杂 的算法，我凡是 只会插上一两句注解。我有一个十分 复杂 的法例 来匡助 我和其别人 懂得 我的法式 ：正文 应当 尽量 无效 地去匡助 任何一团体 了解 和利用 我的代码。

　　一旦我晓得 一行特定代码要做的工作 后，写的进程 实际上是 十分 复杂 而直接的。也有些法式 需求 用到十分 规算法，这时候 我会写下我算法的次要 思绪 ，来摸索 其可行性，同时也匡助 我更高效的 Debug。

　　除 那些出格 主要 的代码，凡是 我的正文 都长短 正式的。在曩昔 的十年里，需求 我写正确 并正式正文 的次数其实不 多。但关于 一个十分 庞杂 的体系 来讲 ，正文 的主要 性不言自明。很少有工程师会在构建一个庞杂 体系 时，花工夫 去写好正文 。有些黉舍 也会教你怎样 写正文 ，但更多时分 都是教你若何 写好代码。这需求 理论 ，假如 你没有画过搭建一座平房的图纸，你很难直接画出摩天大楼的蓝图。

　　写好正文 也没有一个复杂 的原则 ，但有一点你要尽可能 防止 ，那就是用代码去注释 代码。就仿佛 你不克不及 用两团体 们都不睬 解的器材 ，用个中 一个去注释 别的 一个。修建 师也不克不及 直接用砖块来告知 你，他想搭建一个甚么 样的房子。

　　懂得 一个庞杂 的体系 ，最好的举措 就是将其中心 用复杂 的概念，笼统 的归纳综合 出来。初中数学的一些根基 概念可以用来匡助 你写好正文 ，好比 你可以用一些纠合 、方程和复杂 的逻辑来注释 你的代码。关于 一些庞杂 的算法，你也能够 引入数学里没有过的概念来加以注释 。总的来讲 ，假如 你的正文 偏离一些笼统 的数学根基 概念越远，了解 起来也就越坚苦 。

　　思虑 其实不 能包管 咱们 不出错 ，但不思虑 ，出错 是没法 防止 的。 正文 能匡助 咱们 将毛病 最小化，同时它还能进步 咱们 改错的效力 ，节俭 咱们 的工夫 。