ecshop編碼命名規(guī)范

《ecshop編碼命名規(guī)范》由會員上傳分享，免費在線閱讀，更多相關(guān)內(nèi)容在行業(yè)資料-天天文庫。

1、ECSHOPv2.x代碼規(guī)范ECSHOP編碼規(guī)范1.編輯器設(shè)定1.1.縮進(jìn)所有的縮進(jìn)使用空格取代Tab制表符。PHP文件采用4個空格的縮進(jìn)，HTML文件以及HTML文件中嵌入的Javascript代碼采用2個空格的縮進(jìn)；單獨的Javascript以及CSS文件采用4個空格的縮進(jìn)。1.2.字符編碼所有PHP、HTML文件均保存為NoBomUTF-8的字符編碼。變量名應(yīng)當(dāng)全部小寫，并且詞語之間以單個下劃線分隔。例如：$current_user是正確的，但是$currentuser和$CurrentUser就不正確。名稱應(yīng)當(dāng)是描述性的，并且簡明。我們自然不希望使用冗長的句子作為變量名，但是多輸入幾

2、個字符總好于疑惑于某個變量到底是干什么用的。1.3.循環(huán)計數(shù)器允許使用一個單字符變量名的唯一情形是當(dāng)它作為一個循環(huán)計數(shù)器的時候。在這種情況下，外層循環(huán)的計數(shù)器應(yīng)當(dāng)始終是$i。如果有一個循環(huán)處于這個循環(huán)的內(nèi)部，它的計數(shù)器應(yīng)當(dāng)是$j，進(jìn)而是$k，等等。如果循環(huán)的計數(shù)器是一個已經(jīng)存在并且名字有意義的變量，本規(guī)范并不適用。例如：for($i=0;$i<$outer_size;$i++){??for($j=0;$j<$inner_size;$j++)??{????foo($i,$j);??}?}ECSHOPv2.x代碼規(guī)范1.1.函數(shù)名稱函數(shù)也應(yīng)該描述性地命名。這里我們并非在用C編程，我們不希望寫出諸

3、如“stristr()”此類的函數(shù)來。同上，使用單詞間用單下劃線分隔的小寫名稱。函數(shù)名稱中某處最好有一個動詞。較好的函數(shù)名稱如print_login_status()，get_user_data()，等等。1.2.函數(shù)參數(shù)參數(shù)遵循和變量名字相同的約定。我們不希望一堆這樣的函數(shù)：do_stuff($a,$b,$c)。在大部分情況下，我們希望僅僅看看函數(shù)的聲明，就知道怎樣使用它。1.3.類的名稱類的名稱首先必須是一個有意義的英文單詞或者詞組。同時在書寫格式上為了使類名和函數(shù)、變量有一個區(qū)別，我們要求類的名稱全小寫的寫法，并且加上cls_作為前綴。例如：/*錯誤的寫法*classimage_han

4、dle{}classimagehandle{}classimageHandle{}/*正確的寫法*classcls_imagehandle{}1.4.總結(jié)這里的基本哲學(xué)是不要為了偷懶而傷害了代碼的清晰。但是，必須由一些常識來掌握這種平衡；例如，print_login_status_for_a_given_user()做得就過火了——這個函數(shù)命名為print_user_login_status()更好些，或只是print_login_status()。2.代碼布局這里是一個頭部的模板，所有的PHP文件的開始都必須包含下面的內(nèi)容：/***ECSHOP升級程序之控制器*==============

5、==============================================================*版權(quán)所有(C)2005-2007康盛創(chuàng)想（北京）科技有限公司，并保留所有權(quán)利。*網(wǎng)站地址:http://www.ecshop.comECSHOPv2.x代碼規(guī)范*----------------------------------------------------------------------------*這是一個免費開源的軟件；這意味著您可以在不用于商業(yè)目的的前提下對程序代碼*進(jìn)行修改、使用和再發(fā)布。*============================

6、================================================*$Author$*$Date$*$Id$*/1.1.注釋的寫法根據(jù)流行的注釋寫法我們要求對于代碼段的注釋采用以下的方式來書寫：/*注釋內(nèi)容*/對于單行的注釋則使用下面的注釋形式，注意在//之后有一個空格：define(‘IN_ECS’,ture);//注釋內(nèi)容1.2.始終包含大括號這是因為懶于多敲兩個字符而給代碼清晰帶來問題的又一個情形。盡管有些結(jié)構(gòu)的主體部分只有一行，千萬不要丟掉大括號。絕對不要。例如：/*這些都錯了*/if(condition)do_stuff();if(condition)

7、do_stuff();while(condition)do_stuff();for($i=0;$i