1.3.6  文件夾組織結(jié)構(gòu)

在編寫代碼之前，可以把系統(tǒng)中可能用到的文件夾先創(chuàng)建出來（例如，創(chuàng)建一個名為images的文件夾，用于保存網(wǎng)站中所使用的圖片），這樣不但可以方便以后的開發(fā)工作，也可以規(guī)范網(wǎng)站的整體架構(gòu)。本系統(tǒng)的文件夾組織結(jié)構(gòu)如圖1.19所示。

1.3.7  編碼規(guī)則

編碼規(guī)范可使程序員在編程時注意一些細節(jié)問題，提高程序的可讀性，讓程序員能夠盡快地理解代碼，并幫助程序員編寫出規(guī)范的、利于維護的程序代碼。在開發(fā)項目時，主要應注意程序中的編碼規(guī)則和數(shù)據(jù)庫的編碼規(guī)則，下面分別進行介紹。

1．程序編碼規(guī)則

程序的編碼規(guī)則，可分為命名規(guī)則與書寫規(guī)則。

? 命名規(guī)則。

在程序中進行命名時，應注意以下幾點。

（1）常量的命名。

常量名通常使用大寫，并且能夠“見其名知其意”。若由單詞組成，單詞間用下劃線隔開，例如，定義一個MIX_VALUE常量用來存儲一個最小值。

（2）變量的命名。

變量名應為小寫，且要有意義，盡量避免使用單個字符，否則遇到該變量時很難理解其用途。對于臨時的變量，如記憶循環(huán)語句中的循環(huán)次數(shù)，通?？擅麨镮、k這樣的單字符變量名。

（3）方法的命名。

方法被調(diào)用來執(zhí)行一個操作，所以方法名應是對該操作的描述。方法名的首字母應該小寫，若由多個單詞組成，則其后單詞的首字母大寫。例如，用來添加用戶的方法，可命名為addUser()。

（4）對包的命名規(guī)范。

包名的前綴應全部由小寫英文字母組成，例如java.io。

（5）對類、接口的命名規(guī)范。

類名與接口名應使用名詞，首字母需大寫；若由多個單詞組成，則每個單詞的首字母應大寫；盡量使名字簡潔且富于描述性。例如RandomAccessFile。

? 書寫規(guī)則。

在編寫代碼時，應注意以下幾點。

（1）在聲明變量時，盡量使對每個變量的聲明單獨占一行，即使是聲明相同類型的變量，這樣有助于加入注釋。局部變量應在聲明的同時進行初始化，在類型與標志符號之間可使用空格或制表符。例如：

int store=100; //庫存量

int sale=20; //售出數(shù)量

float price=49.5f; //價格

（2）語句應以英文狀態(tài)下的分號“;”結(jié)束，且應使每條語句單獨占一行。

（3）盡量不要使用技巧性很高但難懂、易混淆判斷的語句，這將為后期項目的維護留下難度。

（4）在代碼進行縮進時，應使用制表符來代替空格。

（5）編寫代碼時，要適當?shù)厥褂每招蟹指舸a，便于閱讀者很快地了解代碼結(jié)構(gòu)，并且要在難以理解及關鍵部分加入注釋。

2．數(shù)據(jù)庫編碼規(guī)則

? 數(shù)據(jù)庫的命名。

本書中所有數(shù)據(jù)庫的命名都是以“db_”開頭，db為database的縮寫，后面加上對數(shù)據(jù)庫進行描述的相關英文單詞或縮寫，如表1.3所示。

本書中所有數(shù)據(jù)表的命名都是以“tb_”開頭，tb為table的縮寫，后面加上對數(shù)據(jù)表進行描述的相關英文單詞或縮寫，如表1.4所示。

對于數(shù)據(jù)表中的字段，應命名為小寫英文字母，并且要“見其名知其義”，以便從名字上便能得知該字段所存儲內(nèi)容的意義，如表1.5所示。