1 排版
1-1:程序块要采用缩进风格编写,缩进的空格数为4个。
1-2:相对独立的程序块之间和相对独立的变量定义之后必须加空行。
1-3:较长的语句(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。
1-4:循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首。
1-5:若函数或过程中的参数较长,则要进行适当的划分。
1-6:在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如.->::),后不应加空格。
1-7:一行程序以小于80字符为宜,不要写得过长。
2 注释
2-1:一般情况下,源程序有效注释量必须在20%以上。
2-2:源代码应在开始处进行注释,注释应列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志、调用示例等。
2-3:事件、方法、过程的代码应在开始处进行注释,注释应列出:版权说明、版本号、生成日期、作者、模块目的/功能、修改日志、调用示例等。
2-4:过程的头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用示例等。
2-5:边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。
2-6:注释的内容要清楚、明了,含义准确,防止注释二义性。
2-7:避免在注释中使用缩写,特别是非常用缩写。
2-8:注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。
2-9:对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在定义时都必须加以注释,说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。
2-10:全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。
2-11:注释与所描述内容进行同样的缩排。
2-12:将注释与其上面的代码用空行隔开。
2-13:对变量的定义和分支语句(条件分支、循环语句等)必须编写注释。
2-14:通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构,使代码成为自注释的。
2-15:在代码的功能、意图层次上进行注释,提供有用、额外的信息。
2-16:在程序块的结束行右方加注释标记,以表明某程序块的结束。
2-17:注释格式尽量统一,建议使用“*--”和“&&--”。
2-18:注释应考虑程序易读及外观排版的因素,使用的语言若是中、英兼有的,建议多使用中文,除非能用非常流利准确的英文表达。
参考资料:华为软件编程规范
*-- 群:VFP软件开发(55569163)