22.2.10软件编码规范评审

    程序实际上是一种供人阅读的文章，也有一个文章的风格问题。应该使程序具有良好的风格，具体表现在:源程序文档化、数据说明的方法、语句结构和输入/输出方法等。

    1.源程序文档化

    1)符号名的命名

    符号名即标识符，包括模块名、变量名、常量名、标号名、子程序名、数据区名以及缓冲区名等等。这些名称应能反映它所代表的实际东西，应有一定的实际意义。例如，表示次数的量用Times，表示总量的量用Total，表示平均值的量用Average，表示和的量用Sum等等。

  名称不是越长越好，应当选择精炼的、意义明确的名称。必要时可使用缩写名称，但这时要注意缩写规则要一致，并且要给每一个名称加注释。同时，在一个程序中，一个变量只应用于一种用途。

    2)程序的注释

    夹在程序中的注释是程序员与日后的程序读者之间通信的重要手段。注释绝不是可有可无的。一些正规的程序文本中一注释行的数量占到整个源程序的1/3－1/2，甚至更多。注释分为序言性注释和功能性注释。

    序言性注释通常置于每个程序模块的开头部分，它应当给出程序的整体说明，对子理解程序本身具有引导作用。有些软件开发部门对序言性注释做了明确而严格的规定，要求程序编制者逐项列出。有关项目包括:程序标题;有关本模块功能和目的的说明;主要算法;接口说明(包括调用形式、参数描述、子程序清单);有关数据描述(重要的变量及其用途、约束或限制条件，以及其他有关信息);模块位置(在哪一个源文件中，或隶属十哪一个软件包);开发简历(模块设计者、复审者、复审日期、修改日期及有关说明)等。

    功能性注释功能性注释嵌在源程序体中，用于描述其后的语句或程序段是在做什么工作，或是执行了下面的语句会怎么样。而不要解释下面怎么做。要点:描述一段程序，而不是每一个语句;用缩进和空行，使程序与注释容易区别;注释要正确。

    3)标准的书写格式

视觉组织用空格、空行和移行来实现。恰当地利用空格，可以突出运算的优先性，减少发生编码的错误;自然的程序段之间可用空行隔开;移行也叫做向右缩格，它是指程序中的各行不必都在左端对齐，不必都从第一格起排列，这样做可以使程序分清层次关系。对于选择语句和循环语句，把其中的程序段语句向右做阶梯式移行，使程序的逻辑结构更加清晰。

    2.数据说明

    在设计阶段己经确定了数据结构的组织及其复杂性。在编写程序时，则需要注意数据说明的风格。为了使程序中数据说明更易于理解「和维护，必须注意以下几点。

    1)数据说明的次序应当规范化

    数据说明次序规范化，使数据属性容易查找，也有利于测试、排错和维护。原则上，数据说明的次序与语法无关，其次序是任意的。但出于阅读、理解和维护的需要，最好使其规范化，使说明的先后次序固定。

    2)说明语句中变量安排有序化

    当多个变量名在一个说明语句中说明时，应当对这些变量按字母的顺序排列。带标号的全程数据也应当按字母的顺序排列。

    3)使用注释说明复杂数据结构

    如果设计了一个复杂的数据结构，应当使用注释来说明在程序实现时这个数据结构的固有特点。

    4)语句结构

    在设计阶段确定了软件的逻辑流结构，但构造单个语句则是编码阶段的任务。语句构造力求简单、直接，不能为了片面追求效率而使语句复杂化。

    比如，在一行内只写一条语句;程序编写首先应当考虑清晰性;程序要能直截了当地说明程序员的用意:除非对效率有特殊的要求，程序编写要做到清晰第一，效率第二，不要为了追求效率而丧失了清晰性;首先要保证程序正确，然后才要求提高速度，也就是在使程序高速运行时，首先要保证它是正确的;避免使用临时变量而使可读性下降;让编译程序做简单的优化;尽可能使用库函数;避免不必要的转移;尽量采用基本的控制结构来编写程序;避免采用过于复杂的条件测试;尽量减少使用“否定”条件的条件语句;尽可能用通俗易懂的伪码来描述程序的流程，然后再翻译成必须使用的语言;数据结构要有利于程序的简化;程序要模块化，使模块功能尽可能单一化模块间的耦合能够清晰可见;利用信息隐蔽，确保每一个模块的独立性;从数据出发去构造程序;不要修补不好的程序，对不好的程序要重新编写。

    3.输入和输出

输入和输出信息是与用户的使用直接相关的。输入和输出的方式和格式应当尽可能方便用户的使用。一定要避免因设计不当给用户带来的麻烦。因此，在软件需求分析阶段和设计阶段，就应基本确定输入和输出的风格。系统能否被用户接受，有时就取决于输入和输出的风格。输入/输出风格还受到许多其他因素的影响。例如输入/输出设备(如终端的类型、图形设备、数字化转换设备等)、用户的熟练程度，以及通信环境等。不论是批处理的输入/输出方式，还是交互式的输入/输出方式，在设计和程序编码时都应考

虑下列原则:

    (1)对所有的输入数据都要进行检验，识别错误的输入，以保证每个数据的有效性。

    (2)检查输入项的各种重要组合的合理性，必要时报告输入状态信息。

    (3)使得输入的步骤和操作尽可能简单，并保持简单的输入格式。

    (4)输入数据时，_应允许使用自由格式输入。

    (5)‘应允许默认值。

    (6)输入一批数据时，最好使用输入结束标志，而不要由用户指定输入数据数目。

    (7)在交互式输入时，要在屏幕上使用提示符明确提示交互输入的请求，指明可使用选择项的种类和取值范围。同时，在数据输入的过程中和输入结束时，也要在屏幕上给出状态信息。

    (8)当程序设计语言对输入/输出格式有严格要求时，应保持输入格式与输入语句的

要求的一致性。

    (9)给所有的输出加注解，并设计输出报表格式。