编程的原则

一．编写的每个程序、函数和方法要包含准确的前置条件和后置条件。

二．最审慎地选择类、变量和函数的名称，并予以详尽的解释。

  *指导原则：

1．特别审慎地选择在程序的不同部分中使用的类、函数、常量和所有全局变量的名称。这些名称应该是有意义的，并且能够明确的指示这个类、函数、变量等的目的。

2.对仅是暂时局部的使用的变量，保持其名称简单。

3.使用的通用的前缀或后缀来关联同一常规类别的名称。

4.避免采用故意的误拼和无意义的后缀来获得不同的名称。

5.避免选择那些本身意义与问题毫无关系或只有很少关系的漂亮的名称。

6.避免选择拼写相互接近或者其他方面易于混淆的名称。

7.应小心使用字母“l”“o”和“0”（零）。

三．保持文档简练但具有描述作用。

 *指导原则：

1.在每个函数开始的开始处放上序言，包括：

 （1）身份证明；

  (2)所用函数和算法的目的的说明；

 （3）函数所作的修改及其所用的数据；

 （4）对程序外部更多文档的引用。

2.当定义每个变量、常量或类时，解释清楚它是什么和如何使用。如果从名称就能明显看出这些信息则更好。

3.对程序的每个重要片段（段落或函数），用一句注释简要说明它的目的或动作。

4.如果每个重要片段的结束不明显，则加以指示。

5.避免机械模仿代码功能的注释。

6.对任何使用了技巧或意义不清的语句加以解释，如果能避免使用这样的语句则更好。

7.代码本身应该解释程序是如何工作的，文档应解释它为什么工作及它做什么。

8.无论何时修改一个程序，确信文档得到了相应的修改。

四．阅读的时间比编写程序的时间多得多，使阅读更容易。

五．自顶向下的细化，是编写能运行的大型程序的真正关键。

六．使用类来模拟程序的基本概念。

七．每个函数应该仅仅完成一项任务，但要很好的完成。

八．每个类或函数应该隐藏某些东西。

九．保持连接简单，尽可能避免使用全局变量。

十．如果必须使用全局变量作为输入，则详细的将它们写进文档，只能够避免，切勿引起副作用。

十一.将输入输出作为独立的函数，使得它们易于修改并能定制修改以适应计算系统。

十二.测试数据的质量比数量更重要。

十三.程序测试可用于说明bug的存在，而不能说明其不存在。

十四.对于一个大型且重要的程序，超过一半的工作是在它被完全测试并且投入使用后，来自于维护阶段。

十五.确信你完全地了解了问题，如果必须改变其条件，则确切解释所作的修改。

十六.最精心设计用户接口。

十七.除非必要，不要优化代码，在代码完善和正确之前不要开始优化代码，提高程序效率。

十八.尽量保持算法简单。

十九.有时延缓问题会简化解决方案。

二十.在需求说明准确和完善前不要进行编码。

二十一.匆匆行动，慢慢后悔，匆匆编程，常常调试。

二十二.重新开始比给一个旧程序打补丁更简单。

二十三.总是计划建立原型并丢弃它，不管是否计划都必须这样做。