PEAR 程式撰寫標準-命名規則

日期 2010年08月15日 15:42:58 | 新聞類別: 模組開發

原始出處 http://www.xoops.org/modules/mediawiki/index.php/Dev:coding_standards


 

類別

類別應該有一個有意義的名稱,儘量不要使用縮寫。類別名稱的第一個字元應該要是大寫字。PEAR 的類別階層也反應在類別名稱上,每一個階層的都會用一個下引線隔開。良好的類別名稱如下:

Log
Net_Finger
HTML_Upload_Error

函式(function)與成員函式(method

函式與成員函式命名方式應該使用"studly caps"風格(也有人稱為"bumpy case"或是"camel caps")。函式應該要有包裹(package)的名稱當作前綴字以避免包裹間的命名衝突。前綴字後的第一個字元是小寫,之後每個單字的第一個字元都是大寫。範例如下:

connect()
getData()
buildSomeWidget()
XML_RPC_serializeData()

私有的類別成員(意思是這些成員只給宣告為相同類別的程式使用而已,PHP 還沒真正支援私有命名空間)第一個字元都要是下引線。範例如下:

_sort()
_initTree()
$this->_status

常數

常數名稱都應該是大寫字元,也可以用下引線分開單字。常數名稱的前綴字應該是使用這個變數的類別/包裹的名稱。舉例來說,DB::包裹使用的常數名稱的前綴字就應該是"DB_"。

全域變數

如果包裹中需要定義全域變數的話,變數名稱第一個字元是下引線,接著是包裹名稱,再另外一個下引線。舉例來說,PEAR 包裹使用的全域變數名稱可以是$_PEAR_destructor_object_list。





本篇新聞來自:XOOPS Site
https://www.xoops.org.tw

本篇新聞的連結網址是:
https://www.xoops.org.tw/modules/news/article.php?storyid=38