騰訊php開發(fā)規(guī)范

《騰訊php開發(fā)規(guī)范》由會員上傳分享，免費(fèi)在線閱讀，更多相關(guān)內(nèi)容在教育資源-天天文庫。

1、OMG網(wǎng)絡(luò)媒體技術(shù)部海豹平臺開發(fā)規(guī)范v1.0海豹平臺開發(fā)規(guī)范v1.0騰訊科技（深圳）有限公司*版本信息&保密等級版本更改日期更改要點說明編制審核批準(zhǔn)V1.02013/12/24新建wilsonwsongOMG網(wǎng)絡(luò)媒體技術(shù)部海豹平臺開發(fā)規(guī)范v1.0V1.12013/12/26修訂rusherding文檔保密等級：□機(jī)密■內(nèi)部□公開OMG網(wǎng)絡(luò)媒體技術(shù)部海豹平臺開發(fā)規(guī)范v1.0目錄海豹平臺開發(fā)規(guī)范V1.011引言51.1定義及縮略語51.2參考文檔51.3目的51.4適用范圍51.5標(biāo)準(zhǔn)化作用52目錄結(jié)構(gòu)規(guī)范62.1框架路徑62.2應(yīng)用目錄結(jié)構(gòu)6

2、2.2.1配置config72.2.2控制器controllers72.2.3模型models72.2.4視圖views82.2.5國際化messages82.2.6組件components82.2.7命令commands82.2.8臨時目錄runtime82.3路徑別名82.3.1類型導(dǎo)入83PHP編碼規(guī)范93.1標(biāo)簽93.2編碼93.3注釋93.3.1文件注釋93.3.2類注釋103.3.3方法注釋103.3.4屬性注釋113.3.5其它113.4命名規(guī)則113.4.1文件113.4.2類12OMG網(wǎng)絡(luò)媒體技術(shù)部海豹平臺開發(fā)規(guī)范v1.0

3、3.4.3函數(shù)/方法123.4.4變量名123.4.5常量名123.5書寫規(guī)則133.5.1文件133.5.2行133.5.3縮進(jìn)133.5.4控制結(jié)構(gòu)133.5.5運(yùn)算符163.5.6引號163.5.7關(guān)鍵詞173.5.8函數(shù)173.5.9類173.5.10屬性183.5.11方法184數(shù)據(jù)庫命名規(guī)范204.1命名規(guī)范204.2實體命名204.2.1前綴命名204.2.2后綴命名214.3字段命名214.3.1后綴命名224.4字段類型224.4.1數(shù)值類型224.4.2字符類型234.4.3時間類型234.4.4ENUM&SET234.

4、4.5LOB類型234.5表結(jié)構(gòu)設(shè)計244.5.1適度冗余244.5.2盡量使用NOTNULL244.5.3索引245附件245.1附錄一：MYSQL保留字24OMG網(wǎng)絡(luò)媒體技術(shù)部海豹平臺開發(fā)規(guī)范v1.01引言1.1定義及縮略語縮略詞說明海豹平臺運(yùn)維中心提供的研發(fā)平臺，提供框架、公共基礎(chǔ)組件、公共業(yè)務(wù)組件加速業(yè)務(wù)的日常研發(fā)工作1.2參考文檔海豹平臺WIKI：http://wiki.seals.webdev.com/1.3目的本規(guī)范由編程原則組成，融合并提煉了開發(fā)人員長時間積累下來的成熟經(jīng)驗，意在幫助形成良好一致的編程風(fēng)格。以達(dá)到事半功倍的效

5、果，如果有需要本文檔會不定期更新。1.4適用范圍如無特殊說明，以下規(guī)則要求完全適用于基于海豹平臺框架開發(fā)的應(yīng)用，同時也可大部分適用于部門其他PHP項目。1.5標(biāo)準(zhǔn)化作用OMG網(wǎng)絡(luò)媒體技術(shù)部海豹平臺開發(fā)規(guī)范v1.0當(dāng)一個軟件項目嘗試著遵守公共一致的標(biāo)準(zhǔn)時，可以使參與項目的開發(fā)人員更容易了解項目中的代碼、弄清程序的狀況。使新的參與者可以很快的適應(yīng)環(huán)境，防止部分參與者出于節(jié)省時間的需要，自創(chuàng)一套風(fēng)格并養(yǎng)成終生的習(xí)慣，導(dǎo)致其它人在閱讀時浪費(fèi)過多的時間和精力。而且在一致的環(huán)境下，也可以減少編碼出錯的機(jī)會。缺陷是由于每個人的標(biāo)準(zhǔn)不同，所以需要一段時間來

6、適應(yīng)和改變自己的編碼風(fēng)格，暫時性的降底了工作效率。從使項目長遠(yuǎn)健康的發(fā)展以及后期更高的團(tuán)隊工作效率來考慮暫時的工作效率降低是值得的，也是必須要經(jīng)過的一個過程。標(biāo)準(zhǔn)不是項目成功的關(guān)鍵，但可以幫助我們在團(tuán)隊協(xié)作中有更高的效率并且更加順利的完成既定的任務(wù)。1)程序員可以了解任何代碼，弄清程序的狀況2)新人可以很快的適應(yīng)環(huán)境3)防止新接觸PHP的開發(fā)出于節(jié)省時間的需要，自創(chuàng)一套風(fēng)格并養(yǎng)成終生的習(xí)慣4)防止新接觸PHP的開發(fā)一次次的犯同樣的錯誤5)在一致的環(huán)境下，可以減少犯錯的機(jī)會1目錄結(jié)構(gòu)規(guī)范1.1框架路徑框架引用路徑必須采用絕對路徑，托管的開發(fā)、

7、測試和正式環(huán)境必須為：/data/php/framework1.2應(yīng)用目錄結(jié)構(gòu)應(yīng)用需要嚴(yán)格參考以下目錄安排代碼位置：webroot/index.phpWeb應(yīng)用入口腳本文件index-test.php功能測試使用的入口腳本文件assets/包含公開的資源文件css/包含CSS文件images/包含圖片文件themes/包含應(yīng)用主題protected/包含受保護(hù)的應(yīng)用文件OMG網(wǎng)絡(luò)媒體技術(shù)部海豹平臺開發(fā)規(guī)范v1.0modc命令行腳本modc.batWindows下的命令行腳本modc.php命令行PHP腳本commands/包含自定義的'mo

8、dc'命令components/包含可重用的用戶組件config/包含配置文件controllers/包含控制器的類文件SiteController.php默認(rèn)控制器的類文件ex