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

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

1.3.7  編碼規(guī)則

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

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

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

? 命名規(guī)則。

在程序中進(jìn)行命名時(shí)，應(yīng)注意以下幾點(diǎn)。

（1）常量的命名。

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

（2）變量的命名。

變量名應(yīng)為小寫，且要有意義，盡量避免使用單個(gè)字符，否則遇到該變量時(shí)很難理解其用途。對(duì)于臨時(shí)的變量，如記憶循環(huán)語句中的循環(huán)次數(shù)，通常可命名為I、k這樣的單字符變量名。

（3）方法的命名。

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

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

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

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

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

? 書寫規(guī)則。

在編寫代碼時(shí)，應(yīng)注意以下幾點(diǎn)。

（1）在聲明變量時(shí)，盡量使對(duì)每個(gè)變量的聲明單獨(dú)占一行，即使是聲明相同類型的變量，這樣有助于加入注釋。局部變量應(yīng)在聲明的同時(shí)進(jìn)行初始化，在類型與標(biāo)志符號(hào)之間可使用空格或制表符。例如：

int store=100; //庫(kù)存量

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

float price=49.5f; //價(jià)格

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

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

（4）在代碼進(jìn)行縮進(jìn)時(shí)，應(yīng)使用制表符來代替空格。

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

2．?dāng)?shù)據(jù)庫(kù)編碼規(guī)則

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

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

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

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