文件結(jié)構(gòu)

|――images
|――include
　　|――parameter
　　|――config
　　|――function
|――index
images存放圖片文件，include中是系統(tǒng)是要引用的文件，一般在parameter中存放參數(shù)文件，config中存放配置文件，function中存放方法文件，如javascript的方法等，并按功能模塊的分類，將各功能的類也放入其中
文件名
文件夾命名一般采用英文，長度一般不超過20個(gè)字符，命名采用小寫字母。除特殊情況才使用中文拼音，一些常見的文件夾命名如：images(存放圖形文件)，flash（存放Flash文件），style(存放CSS文件)，scripts（存放Javascript腳本），inc(存放include文件)，link（存放友情鏈接）,media(存放多媒體文件)等。文件名稱統(tǒng)一用小寫的英文字母、數(shù)字和下劃線的組合。
塊注釋
塊注釋通常用于提供對文件，方法，數(shù)據(jù)結(jié)構(gòu)和算法的描述。塊注釋被置于每個(gè)文件的開始處以及每個(gè)方法之前。它們也可以被用于其他地方，比如方法內(nèi)部。在功能和方法內(nèi)部的塊注釋應(yīng)該和它們所描述的代碼具有一樣的縮進(jìn)格式。
塊注釋之首應(yīng)該有一個(gè)空行，用于把塊注釋和代碼分割開來，比如：
/*
　* 這里是塊注釋
*/
塊注釋可以以/*-開頭，這樣indent(1)就可以將之識(shí)別為一個(gè)代碼塊的開始，而不會(huì)重排它。
/*-
　* 如果想被忽略，可是使用特別格式的塊注釋
　*
　* one
　* 　　two
　* 　　　　three
　*/
注意：如果你不使用indent(1)，就不必在代碼中使用/*-，或?yàn)樗丝赡軐δ愕拇a運(yùn)行indent(1)作讓步。
單行注釋
短注釋可以顯示在一行內(nèi)，并與其后的代碼具有一樣的縮進(jìn)層級(jí)。如果一個(gè)注釋不能在一行內(nèi)寫完，就該采用塊注釋。單行注釋之前應(yīng)該有一個(gè)空行。以下是一個(gè)代碼中單行注釋的例子：
if (condition) {
　　/* 以下代碼運(yùn)行的條件 */
　　...
}
尾端注釋
極短的注釋可以與它們所要描述的代碼位于同一行，但是應(yīng)該有足夠的空白來分開代碼和注釋。若有多個(gè)短注釋出現(xiàn)于大段代碼中，它們應(yīng)該具有相同的縮進(jìn)。
以下是一個(gè)代碼中尾端注釋的例子：

行末注釋
注釋界定符"http://"，可以注釋掉整行或者一行中的一部分。它一般不用于連續(xù)多行的注釋文本；然而，它可以用來注釋掉連續(xù)多行的代碼段。以下是所有三種風(fēng)格的例子：

文檔注釋
文檔注釋描述php的類、構(gòu)造器，方法，以及字段(field)。每個(gè)文檔注釋都會(huì)被置于注釋定界符/**...*/之中，一個(gè)注釋對應(yīng)一個(gè)類或成員。該注釋應(yīng)位于聲明之前：

/**
　* 說明這個(gè)類的一些 ...
*/
class Example { ...

注意頂層(top-level)的類是不縮進(jìn)的，而其成員是縮進(jìn)的。描述類的文檔注釋的第一行(/**)不需縮進(jìn)；隨后的文檔注釋每行都縮進(jìn)1格(使星號(hào)縱向?qū)R)。成員，包括構(gòu)造函數(shù)在內(nèi)，其文檔注釋的第一行縮進(jìn)4格，隨后每行都縮進(jìn)5格。
若你想給出有關(guān)類、變量或方法的信息，而這些信息又不適合寫在文檔中，則可使用實(shí)現(xiàn)塊注釋(見5.1.1)或緊跟在聲明后面的單行注釋(見5.1.2)。例如，有關(guān)一個(gè)類實(shí)現(xiàn)的細(xì)節(jié)，應(yīng)放入緊跟在類聲明后面的實(shí)現(xiàn)塊注釋中，而不是放在文檔注釋中。
文檔注釋不能放在一個(gè)方法或構(gòu)造器的定義塊中，因?yàn)槌绦驎?huì)將位于文檔注釋之后的第一個(gè)聲明與其相關(guān)聯(lián)。

最新評(píng)論