良好的编程规范

Posted 2020-07-11 Miranda-lym

制定编程规范的目的：1、保证代码的可读性    2、保证代码的维护性

如aa、 bb 之类的命名是不符合编程规范的，后期维护的过程中，面对成百上千的代码，很快便会不知道这些常量和变量的意义了，给后期维护带来的麻烦是不可小觑的

要体现代码之美，可以从以下方面改进：

1、代码简洁，避免冗余，要使代码统一，易于阅读，就要做到遵循严格的规范

　　每个源程序文件都应有文件头说明

　　每个函数都有函数头说明

　　主要变量(结构、联合、类或对象)在定义或引用时，应添加能反映其含义的注释

　　常量定义时应有相应的说明

　　变量、常量和函数的命名都应一目了然

　　处理过程的每个阶段应有相应的注释说明

　　在典型算法前都有注释，一目了然的语句不加注释

　　保持注释与代码完全对应

　　利用缩进来显示程序的逻辑结构（缩进后的代码在后期维护时会结构清晰且易于维护）

2、使代码不受单一平台和编译器的制约，方便日后的移植，即增加适应性，这就要求开发的程序能在几乎所有的环境下都能成功的运行而不仅是局限于开发者的环境中，例如Web开发工程师就应该保证自己的程序能在类型繁多，版本繁多的浏览器中均能运行且不会造成兼容性问题。

3、保证基本安全，避免代码漏洞，意味着该软件在测试运行的过程中具备避免可能发生故障的能力，且一旦发生故障，能自我解除或排除故障，软件的可靠性必须在设计阶段就确定，在开发和测试阶段再考虑就困难了，同时，软件应有一定的健壮性和可扩展性，即软件对于规范要求以外的输入能够判断出这个输入不符合规范要求且有合理的处理方式，软件设计完成后要留有升级接口和升级空间，对扩展开放，对修改关闭。