PHP程序員必知的文件名命名規范

2017-05-08 3231 2 編輯:深圳網站建設 來源:互聯網

編碼規則采用常用規則就可,具體說哪一個好,哪一個不好也是不科學的,每種風格都有各自的好處,這得看系統,代碼怎樣容易閱讀這才是王道。

最基本要求

以標準計算機英文為藍本,杜絕一切拼音、或拼音英文混雜的命名方式。英語不好者,請借助網絡上的翻譯工具。

一、變量命名

(1)使用英文名詞、動詞,以大寫字母作為單詞的分隔,其他的字母均使用小寫,單詞的首個字母使用小寫。如:

 $repeatCount = '';

 $delUserSql = '';

(2)變量命名如要用縮寫,只能使用項目中有據可查的英文縮寫方式,例如可以使用$data而不可使用$data1、$data2這樣容易產生混淆的形式,應當使用$articleData、$userData這樣一目了然容易理解的形式。

(3)除非特殊情況,一般不推薦使用下劃線。如:$repeat_count = '';(不推薦)

二、數組變量命名

使用英文名詞、動詞,以大寫字母作為單詞的分隔,其他的字母均使用小寫,單詞的首個字母使用小寫,不使用下劃線,以字符串 Array 為后綴,例:      $scopeArray = array(); $bookIdArray = array();

提示:

除非特殊情況,一般不推薦使用下劃線。如:$book_id_array = array();(不推薦)

三、全局變量

全局變量應該帶前綴‘g’, 使用大寫字母作為詞的分隔,其他的字母均使用小寫。理由:知道一個變量的作用域是非常重要的。 例如:global $gLog;

四、全局常量命名     

使用英文名詞、動詞,所有字母都使用大寫,以下劃線'_'分隔每個單詞。這是命名全局常量的傳統。例如:

define( 'WEBSITE_NAME', '名稱' );

define( 'WEBSITE_URL', '地址' )

define("A_GLOBAL_CONSTANT", "Hello world!");

五、靜態變量命名

第一種寫法:靜態變量應該帶前綴‘s’,使用大寫字母作為詞的分隔,其他的字母均使用小寫。理由:知道一個變量的作用域是非常重要的。 例如:

function test(){  

static $sStatus = 0;

}

第二種寫法:使用英文名詞、動詞,以大寫字母作為單詞的分隔,其他的字母均使用小寫,單詞的首個字母使用小寫,不使用下劃線,以字符串 Static 為后綴,  例如:

function getDirectoryFile(){

         static $fileArrayStatic = '';

         static $fileNumStatic = '';

...

}

        function getDirectoryFile(){

                         static $fileArrayStatic = '';

                         static $fileNumStatic   = '';

                         ...

                }

六、函數命名

函數名使用小寫字母、下劃線組合。如:get_client_ip().函數名字采用C語言的慣例,所有的字母使用小寫字母,使用'_'分割單詞。 這樣可以更易于區分相關聯的類名。

注意點1:不要把小括號和函數名緊貼在一起。 要用空格隔開它們。 如果小括號緊貼著函數名,二者很容易被看成是一體的。

例如:

  function some_bloody_function () {

  ...

  }

注意點2:除非必要,不要在Return返回語句中使用小括號。

七、類的命名規范

(1). 使用英文名詞,類文件采用駝峰式寫法。以大寫字母作為詞的分隔,其他的字母均使用小寫,名詞的首個字母使用大寫,不使用下劃線。

(2). 使用完整單詞,避免縮寫詞(除非該縮寫詞被更廣泛使用,像URL,HTML)

(3). 在為類命名前首先要知道它是什么。如果通過類名提供的線索,您還是想不起這個類是什么的話,那么您的設計是做得不夠好。

(4). 超過三個單詞組成的混合類名是容易造成系統各個實體間的混淆,請重新設計類名。

例如:

class UserAccount{

...

}

class PaintingOrder{

...

}

八、類文件命名規范

類的文件名與類的名字保持一致,包括大小寫以“ .class.php”作為文件的后綴。 如:MyDb類保存的文件名稱是MyDb.class.php,MySql類保存的文件名稱是MySql.class.php,Page類保存的文件名是Page.class.php,UserName類保存的文件名稱是:UserName.class.php 。

注意:正是由于類的文件名要與類的名字保持一致,所以一個php文件只能包含一個類定義編碼。

九、類屬性命名規范

使用英文名詞、動詞,以大寫字母作為詞的分隔,其他的字母均使用小寫,對于類屬性為某個對象變量,則以字符串 Object 為后綴,普通屬性命名規范同變量的命名規范。如果是用于存儲對象的屬性,使用1個下劃線開始。例如:

public $tableName = '';

private $databaseObject = '';

public  $_username        = NULL;

十、類方法命名規范

類中的方法可自行定義如下兩種,

1)全部使用小寫用下劃線作為詞的分隔 (get_file_content),            

2)采用駝峰法,即以大寫字母作為詞的分隔,其他的字母均使用小寫,

通常每個方法只執行一項邏輯動作事務,所以對它們的命名應該清楚的說明它們是做什么的:

如用checkEmailErrors()代替errorCheck(),用dumpDataToFile()代替dataFile()。這么做使功能和數據成為更可區分的物體。

十一、類方法參數命名

方法的參數的命名規范同變量的命名規范。

十二、類的實例對象的命名(對象變量命名)

類的實例對象的命名規范同變量的命名規范,只不過實例對象是以1個下劃線開頭的,同類中存儲對象的屬性的規范一樣。

這樣,無論是在類的內部,還是類的外部,只要是以下劃線開頭的變量,那就是對象名。(jQuery對象的命名規范與此一致。國外通用。) 例:

$_name = new UserName();

有的公司要求是 "變量名" + "_obj",如:$name_obj;

而有的公司則使用類名稱為變量前綴,所有字母都使用大寫,以字符串_OBJECT 為后綴,例如:

$USERNAME_OBJECT = new UserName();$PAINTINGORDER_OBJECT = new PaintingOrder();

十三、數據庫命名

數據庫表名所有字母都使用小寫,使用'_'作為每個詞的分界,數據字段命名也與數據表命名相同.

例如:

[hide]

cz_goods_attr(商品屬性表)

cz_goods_type(商品類別表)

十四、模板文件名命名

所有字母都使用小寫,使用'_'作為每個詞的分界,這樣做的好處是方便平移到其他的系統平臺中,不會因為大小寫而發生問題.

例如:     

brand_add.html (品牌增加顯示模版文件)

      brand_list.html(品牌展示模版文件)

十五、文件名的命名規范

文件名使用英文名詞、英文動詞,以及下劃線,所有字母都使用小寫字母。例如: index.php、index_ad.html。

專業的網站建設公司,深正互聯,如您有網站營銷需求,請您關注我們,或者致電13828884598

本站文章均為深正網站建設摘自權威資料,書籍,或網絡原創文章,如有版權糾紛或者違規問題,請即刻聯系我們刪除,我們歡迎您分享,引用和轉載,但謝絕直接搬磚和抄襲!感謝...
關注深正互聯
七星彩头尾 港股多赚钱 什么网阅读文章赚钱 33彩票安卓 在澳洲做旅游赚钱吗 给老外当导游赚钱吗 腾讯qq麻将安卓版 天天捕鱼电玩版赢话费 金融服务公司赚钱吗 地下城与勇士代刷赚钱 福建麻将16张玩法 板房蒋阿姨赚钱 摩尘娱乐安卓 郑州达达赚钱吗 捕鱼王二代下载 犯法赚钱路子有哪些 10000炮李逵劈鱼