编程原则

1、源程序文档化

(1)标识符应按意取名。

(2)程序应加注释。注释是程序员与日后读者之间通信的重要工具，用自然语言或伪码描述。它说明了程序的功能，特别在维护阶段，对理解程序提供了明确指导。注释分序言性注释和功能性注释。序言性注释应置于每个模块的起始部分，主要内容有：

①说明每个模块的用途、功能。

②说明模块的接口：调用形式、参数描述及从属模块的清单。

③数据描述：重要数据的名称、用途、限制、约束及其他信息。

④开发历史：设计者、审阅者姓名及日期，修改说明及日期。

功能性注释嵌入在源程序内部，说明程序段或语句的功能以及数据的状态。注意以下几点：

①注释用来说明程序段，而不是每一行程序都要加注释。

②使用空行或缩格或括号，以便很容易区分注释和程序。

③修改程序也应修改注释。

2、数据说明原则

为了使数据定义更易于理解和维护，有以下指导原则：

(1)数据说明顺序应规范，使数据的属性更易于查找，从而有利于测试、纠错与维护。例如按以下顺序：常量寿命、类型说明、全程量说明、局部量说明。

(2)一个语句说明多个变量时，各变量名按字典序排列。

(3)对于复杂的数据结构，要加注释，说明在程序实现时的特点。

3、语句构造原则

语句构造的原则是：简单直接，不能为了追求效率而使代码复杂化。为了便于阅读和理解，不要一行多个语句。不同层次的语句采用缩进形式，使程序的逻辑结构和功能特征更加清晰。要避免复杂的判定条件，避免多重的循环嵌套。表达式中使用括号以提高运算次序的清晰度等等。

4、输入输出原则

输入和输出在编写输入和输出程序时考虑以下原则：

(1)输入操作步骤和输入格式尽量简单。

(2)应检查输入数据的合法性、有效性，报告必要的输入状态信息及错误信息。

(3)输入一批数据时，使用数据或文件结束标志，而不要用计数来控制。

(4)交互式输入时，提供可用的选择和边界值。

(5)当程序设计语言有严格的格式要求时，应保持输入格式的一致性。

(6)输出数据表格化、图形化。

输入、输出风格还受其他因素的影响，如输入、输出设备，用户经验及通信环境等。

5、追求效率原则

指处理机时间和存储空间的使用，对效率的追求明确以下几点：

(1)效率是一个性能要求，目标在需求分析给出。

(2)追求效率建立在不损害程序可读性或可靠性基础上，要先使程序正确，再提高程序效率，先使程序清晰，再提高程序效率。

(3)提高程序效率的根本途径在于选择良好的设计方法、良好的数据结构算法，而不是靠编程时对程序语句做调整。