TWed2k - 程式開發討論區 - TWed2k CodeBank（源碼分享P2P）

daidai
鐵驢友〔中級〕

．積分： 51
．文章： 80
．收花： 325 支
．送花： 166 支
．比例： 0.51
．在線： 1631 小時
．瀏覽： 13352 頁
．註冊： 7118 天
．失蹤： 610 天

#2 : 2012-5-25 05:26 PM 全部回覆	送花 (3) 送出中...

這是之前翻譯 Zend Framework 說明..要給同事看的,多少可以參考看看,可以有些概念

語言:php

命名約定
類別

Zend Framework 的類別命名總是對應於其所屬文件的目錄結構的，ZF 標準庫的根目錄是「Zend/」，ZF 特別（extras）類別庫的根目錄是 "ZendX/"，所有 Zend Framework 的類別在其下按等級存放。

類別名稱只允許有字母數字字元，在大部分情況下不鼓勵使用數字。下標線（"_"）只允許做路徑分隔符號；例如 Zend/Db/Table.php 文件裡對應的類別名稱是 Zend_Db_Table。

如果類別名包含多個單字，每個單字的第一個字母必須大寫，連續的大寫是不允許的，例如「Zend_PDF」是不允許的，而 "Zend_Pdf" 是可接受的。

這些約定為 Zend Framework 定義了一個虛擬命名空間機制。如果對開發者在他們的程式中確實可行，Zend Framework 將採用 PHP 命名空間特性（如果有的話）。

參考在標準和特別庫中類別名稱作為類別名稱約定的例子。重要：依靠 ZF 類別庫展開的程式碼，但又不是標準或特別類別庫的一部分（例如程代碼或不是 Zend 發行的類別庫），不要以 "Zend_" 或 "ZendX_" 開頭。

文件名稱

對於其它文件，只有字母數字字元、下標線（"_"）和破折號（"-"）可用，空格是絕對不允許的。

包含任何 PHP 程式碼的任何文件應當以 ".php" 副檔名結尾，眾所周知的視圖腳本除外。下面這些例子給出 Zend Framework 類別可接受的文件名稱：

Zend/Db.php

Zend/Controller/Front.php

Zend/View/Helper/FormRadio.php

文件名稱必須遵循上述的對應類別名稱的規則。

函式和方法

函式名稱只能包含字母數字字元，下標線（"_"）是不允許的。數字是允許的但大多數情況下不鼓勵。

函式名稱總是以小寫開頭，當函式名稱包含多個單字，每個子的首字母必須大寫，這就是所謂的「駝峰」格式。

我們一般鼓勵使用冗長的名字，函式名稱應當長到足以說明函式的意圖和行為。

這些是可接受的函式名稱的例子：

filterInput()

getElementById()

widgetFactory()

對於物件導向程式設計，實體或靜態變數的存取器總是以 "get" 或 "set" 為前綴。在設計模式實現方面，如單態模式（singleton）或工廠模式（factory），方法的名字應當包含模式的名字，這樣名字更能描述整個行為。

在物件中的方法，定義為 "private" 或 "protected" 的，名稱的首字元必須是一個單個的下標線（"_"），這是唯一的下標線（"_"）在方法名字中的用法。定義為 "public" 的從不包含下劃線。

全域函式 (如："floating functions") 允許但大多數情況下不鼓勵，建議把這類函式封裝到靜態類別裡。

變數

變數只包含數字字母字元，大多數情況下不鼓勵使用數字，下標線（"_"）不接受。

定義為 "private" 或 "protected" 的實體變數名稱必須以一個單個下標線（"_"）開頭，這是唯一的下標線（"_"）在程式中的用法，定義為 "public" 的不應當以下標線（"_"）開頭。

對函式名稱（見上面 3.3 節）一樣，變數名稱總以小寫字母開頭並遵循「駝峰式」命名約定。

我們一般鼓勵使用冗長的名字，這樣容易理解程式碼，開發者知道把資料存到哪裡。除非在小循環裡，不鼓勵使用簡潔的名字如 "$i" 和 "$n" 。如果一個循環超過 20 行程式碼，索引的變數名稱必須有個具有描述意義的名字。

常數

常數包含數字字母字元和下標線（"_"），數字允許作為常數名稱。

常數名稱的所有字母必須大寫。

常數中的單字必須以下標線（"_"）分隔，例如可以這樣 EMBED_SUPPRESS_EMBED_EXCEPTION 但不許這樣 EMBED_SUPPRESSEMBEDEXCEPTION。

常數必須通過 "const" 定義為類別的成員，強烈不鼓勵使用 "define" 定義的全域常數。

=========================================================

另外有個可以參考的地方
小朱® 的技術隨手寫-程式碼命名與撰寫規範

[如果你喜歡本文章，就按本文章之鮮花～送花給作者吧，你的支持就是別人的動力來源]

本文連接

快速回覆