1.3.6 文件夹组织结构
在编写代码之前,可以把系统中可能用到的文件夹先创建出来(例如,创建一个名为images的文件夹,用于保存网站中所使用的图片),这样不但可以方便以后的开发工作,也可以规范网站的整体架构。本系统的文件夹组织结构如图1.19所示。
1.3.7 编码规则
编码规范可使程序员在编程时注意一些细节问题,提高程序的可读性,让程序员能够尽快地理解代码,并帮助程序员编写出规范的、利于维护的程序代码。在开发项目时,主要应注意程序中的编码规则和数据库的编码规则,下面分别进行介绍。
1.程序编码规则
程序的编码规则,可分为命名规则与书写规则。
? 命名规则。
在程序中进行命名时,应注意以下几点。
(1)常量的命名。
常量名通常使用大写,并且能够“见其名知其意”。若由单词组成,单词间用下划线隔开,例如,定义一个MIX_VALUE常量用来存储一个最小值。
(2)变量的命名。
变量名应为小写,且要有意义,尽量避免使用单个字符,否则遇到该变量时很难理解其用途。对于临时的变量,如记忆循环语句中的循环次数,通常可命名为I、k这样的单字符变量名。
(3)方法的命名。
方法被调用来执行一个操作,所以方法名应是对该操作的描述。方法名的首字母应该小写,若由多个单词组成,则其后单词的首字母大写。例如,用来添加用户的方法,可命名为addUser()。
(4)对包的命名规范。
包名的前缀应全部由小写英文字母组成,例如java.io。
(5)对类、接口的命名规范。
类名与接口名应使用名词,首字母需大写;若由多个单词组成,则每个单词的首字母应大写;尽量使名字简洁且富于描述性。例如RandomAccessFile。
? 书写规则。
在编写代码时,应注意以下几点。
(1)在声明变量时,尽量使对每个变量的声明单独占一行,即使是声明相同类型的变量,这样有助于加入注释。局部变量应在声明的同时进行初始化,在类型与标志符号之间可使用空格或制表符。例如:
int store=100; //库存量
int sale=20; //售出数量
float price=49.5f; //价格
(2)语句应以英文状态下的分号“;”结束,且应使每条语句单独占一行。
(3)尽量不要使用技巧性很高但难懂、易混淆判断的语句,这将为后期项目的维护留下难度。
(4)在代码进行缩进时,应使用制表符来代替空格。
(5)编写代码时,要适当地使用空行分隔代码,便于阅读者很快地了解代码结构,并且要在难以理解及关键部分加入注释。
2.数据库编码规则
? 数据库的命名。
本书中所有数据库的命名都是以“db_”开头,db为database的缩写,后面加上对数据库进行描述的相关英文单词或缩写,如表1.3所示。
本书中所有数据表的命名都是以“tb_”开头,tb为table的缩写,后面加上对数据表进行描述的相关英文单词或缩写,如表1.4所示。
对于数据表中的字段,应命名为小写英文字母,并且要“见其名知其义”,以便从名字上便能得知该字段所存储内容的意义,如表1.5所示。