程序开发规范.docx

程序开发规范 、总体要求 1、必须严格执行本规范以确保源代码的可读性及可维护性。 2、所有的程序文件都必须有注释文字,并严格按照本规范中的“注释规范”书写。 、命名规范 概述 1、必须使用语标准英文单词,不允许使用中文拼音。 2、如果有名词,必须使用单数形式。 3、使用大小写混合格式,将连接的几个单词首字母大写。 4、必须在 3 至 30 个字母以内。 5、如果使用缩写,必须使用本规范附录的缩写范例。 文件命名规范 1、文件命名采用主谓结构,首字母大写。 2、文件和文件夹的名称应该精确地说明它们的用途。 函数命名规范 1、函数名和方法名以动词开始,首字母大写,如 SaveFileLog 。 2、在命名函数时包括返回值的说明,如 GetFileName 。 3、类名和属性名以名词开始,首字母大写,如 EmployeeName 。 4、在不同的类中的属性,如果它们有相同的作用,则必须使用同样的名称。 变量命名规范 1、所有变量都必须有前缀,前缀使用 2— 4个字母,全部小写。 2、避免与数据字典中的数据元素名相同。 3、避免与函数名、方法名、类名和属性名相同。 4、避免使变量名为另一个变量名的一部分。 5、布尔变量名应该包含 Is,女口 blnFilelsFound。 常量命名规范 1、常量所有字母都应该大写,单词之间用下划线连接。 三、注释规范 概述 1、注释必须使用中文及中文的标点

文档评论(0)

1亿VIP精品文档

相关文档