定义规范的设计开发标准
一、编程规范
1、编码规范:
(1)在编写代码时,使用四个空格来进行缩进,并且尽量避免使用tab符号;
(2)每个英文关键词、函数名、变量名、属性名、方法名等编写时,使用小写,多个单词之间使用下划线分隔;
(3)在编写代码时,尽量保持一致的缩进风格,尽量不要在一行中使用多个缩进;
(4)每行代码的长度最好不要超过80个字符,可以适当折行;
(5)每个函数最好不要超过一屏;
(6)每个函数开头的注释应当清楚的描述该函数的功能、参数等;
(7)在编写函数时,函数参数应当清楚的描述其变量类型、变量名、意义等,如果有必要,需要说明该参数的取值范围;
(8)在编写代码时,尽量避免使用魔法数字,如果有必要,可以使用常量来取代魔法数字;
(9)在编写函数时,函数内部的变量名应当尽可能的清晰明了,不要编写过于简短的变量名;
2、命名规范:
(1)类名:类名采用大驼峰式,每个单词的首字母都大写,多个单词使用下划线分隔;
(2)变量名:变量名采用小驼峰式,每个单词的首字母都小写,多个单词使用下划线分隔;
(3)函数名:函数名采用小驼峰式,每个单词的首字母都小写,多个单词使用下划线分隔;
(4)属性名:属性名采用小驼峰式,每个单词的首字母都小写,多个单词使用下划线分隔;
(5)方法名:方法名采用小驼峰式,每个单词的首字母都小写,多个单词使用下划线分隔;
3、注释规范:
(1)在编写代码时,尽可能使用注释,使代码更易于理解;
(2)注释应当清楚的描述代码的功能,不要只是简单的描述变量名、函数名等;
(3)使用“//”来注释代码,在每段代码之前,都应当写一行注释;
(4)使用“/* */”来注释代码,在每段代码之前,都应当写一行注释;
二、设计规范
1、系统设计规范:
(1)系统设计时应当尽量考虑系统的可扩展性、灵活性;
(2)系统设计时应当考虑系统的安全性,尽量避免出现安全漏洞;
(3)系统设计时应当考虑性能问题,尽量避免出现性能瓶颈;
(4)系统设计时应当考虑系统的可维护性,系统的设计模块应当清晰、明了;
2、数据库设计规范:
(1)数据库设计时应当考虑数据库的可扩展性和可维护性;
(2)数据库设计时应当考虑数据库的性能,尽量避免出现性能瓶颈;
(3)数据表的字段名应当清晰明了,不要使