第 15 页精品文档---下载后可任意编辑程序设计箴言 1、?程序设计箴言? 这是一种奇异的物质，它相对静止且单独守候，然而又处于永久的运动之中。 它是全部程序的源头，我不知道它的名字，所以我将称它为编程之道……－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－ 1、Includeprecisepreconditionsandpostconditionswitheveryfunctionthatyouwrite. 你编写的每一个函数都应当包含精确 的执行先决条件和后置条件。 每一个函数都应当带有一个说明文档，它由函数的先决条件和后置条件组成，有时还包括该函数所调用函数的函数 2、名列表。所谓先决条件就是函数被调用前必需做的一些初始化工作以及各种形式返回的变量的含义；而后置条件那么包含函数的功能和通过函数调用后以各种形式返回的变量的含义。编写函数说明文档的意义不仅在于阅读程序时，可以快速地对函数有一个大体的了解，更重要的是它能关怀我们避开两个函数间的接口错误。 2、Alwaysnameyourvariablesandfunctionswiththegreatestcare,andexplainthemthoroughly. 要格外慎重地给你的变量和函数命名，使其完好精确 地解释它的功用。 一个程序能够正常工作，精确 的把握每个变量 3、的含义和每个函数的功能是特别重要的。文档当然能起解释的作用，但一个恰如其分的名字却能事半功倍。以下几条建议或许会有所关怀： a.全局变量用具有描述意义的名字。 b.局部变量〔特别是循环变量〕用短名字。 c.函数接受动作性的名字。 d.保持命名的全都性。 e.同一变量名不要有多种含义。 f.不要用过于相像的变量名。 g.变量名中一般不要带有数字。 h.规模较大的程序使用匈牙利表示法。 i.显式地说明变量。 j.对变量最好做出解释说明其含义。 3、Keepyourdocumentationconcisebutdescriptive. 4、保持你的文档简洁，但有较强的描述性。 一个好的文档通常做如下工作： a.像箴言 1 建议的那样给函数作解释。 b.每当声明一个变量、常量、类型时，解释它是什么以及它怎么使用，最好能做到“望文知义〞。 c.程序中的每一个模块都应当以一段简明的说明其功能和操作的解释开场。 d.对程序中没有明显完毕标志的局部做标记。 e.不要大谈明显的东西。 f.对每一个使用了某些小技巧或是含义不明确的语句作解释，更好的做法是避开这种语句的消灭。 g.代码本身应当解释程序是如何运作的，文档应当用来解释做了什么和为什么这样做。 h.无论何...
