编码规范：公共变量的使用原则与注意事项

不同的程序员拥有各自不同的编码风格，但是有一些共同的规则是绝大多数程序员在代码书写中需要遵守的，这些风格有：

（1）关键词和操作符之间加适当的空格；

（2）相对独立的程序块与程序块之间加空行；

（3）较长的语句或表达式等要分成多行书写；

（4）新行要进行适当的缩进；

（5）长表达式要在低优先级操作符处划分新行，操作符放在新行之首；

（6）循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分；

（7）函数或过程中的参数较长，则要进行适当划分；

（8）一般情况下，一行只写一条语句。

编码过程中一个比较容易被初学者忽略的问题是注释语句的书写，一个良好的注释语句书写风格对程序的可读性具有重要的意义。因此，在编码过程中要遵守常见的注释书写风格，这些风格有：

（1）注释要简明扼要；

（2）代码与注释同时书写，保证注释与代码的一致性；

（3）在必要的地方注释，注释量要适中，不能太少也不能太多，注释不能有二义性；

（4）保持注释与其描述的代码相邻；

（5）对代码的注释应放在其上方相邻位置；

（6）全局变量要有较详细的注释，包括功能、取值范围、调用函数等；

（7）源文件的头部有包括文件名、版本号、作者、模块功能描述等注释信息；

（8）函数或过程的开始部分要有注释信息。

为了编码的规范性，变量在使用时应当遵守下列规范：

（1）尽可能少地定义公共变量；(www.xing528.com)

（2）尽量在多个模块或函数中使用相同的公共变量；

（3）注释并明确公共变量的含义、作用、取值范围及与其他公共变量间的关系；

（4）明确公共变量与调用函数的关系；

（5）向公共变量传递数据时，要防止不合理赋值、越界或溢出等现象；

（6）局部变量与公共变量不能同名；

（7）尽量减少存储空间的占用；

（8）不能使用未经初始化的变量；

（9）尽量少地使用数据类型的强制转换功能。

为了编码的规范性，函数（包括自定义函数）在使用时应当遵守下列规范：

（1）函数体内的代码尽量限制在200行以内；

（2）一个函数原则上只完成一个功能；

（3）多次使用的某个功能最好编写成函数；

（4）函数的功能应该是可以预测的；

（5）一个函数的功能尽量不要依赖于其他函数的内部代码；

（6）尽量减少函数的参数；

（7）函数头部用注释语句说明每个参数的作用、取值范围及参数间的关系；

（8）函数执行前要检查参数输入的有效性；

（9）函数名应尽可能描述函数的功能；

（10）尽量减少函数自身或函数间的递归调用。