資源描述:
《騰訊php開發(fā)規(guī)范方案》由會員上傳分享,免費在線閱讀,更多相關內容在工程資料-天天文庫。
1、WORD文檔可編輯海豹平臺開發(fā)規(guī)范v1.0騰訊科技(深圳)有限公司*版本信息&保密等級版本更改日期更改要點說明編制審核批準V1.02013/12/24新建wilsonwsong技術資料專業(yè)分享WORD文檔可編輯V1.12013/12/26修訂rusherding文檔保密等級:□機密■內部□公開技術資料專業(yè)分享WORD文檔可編輯目錄海豹平臺開發(fā)規(guī)范V1.011引言51.1定義及縮略語51.2參考文檔51.3目的51.4適用范圍51.5標準化作用52目錄結構規(guī)范62.1框架路徑62.2應用目錄結構62.2.1配置config72.2.2控制器contr
2、ollers72.2.3模型models72.2.4視圖views82.2.5國際化messages82.2.6組件components82.2.7命令commands82.2.8臨時目錄runtime82.3路徑別名82.3.1類型導入83PHP編碼規(guī)范93.1標簽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類12技術資料專業(yè)分享WORD文檔可編輯3.4.3函數/方法123.4.4變量名123.4.5常量名123.5書
3、寫規(guī)則133.5.1文件133.5.2行133.5.3縮進133.5.4控制結構133.5.5運算符163.5.6引號163.5.7關鍵詞173.5.8函數173.5.9類173.5.10屬性183.5.11方法184數據庫命名規(guī)范204.1命名規(guī)范204.2實體命名204.2.1前綴命名204.2.2后綴命名214.3字段命名214.3.1后綴命名224.4字段類型224.4.1數值類型224.4.2字符類型234.4.3時間類型234.4.4ENUM&SET234.4.5LOB類型234.5表結構設計244.5.1適度冗余244.5.2盡量使用
4、NOTNULL244.5.3索引245附件245.1附錄一:MYSQL保留字24技術資料專業(yè)分享WORD文檔可編輯1引言1.1定義及縮略語縮略詞說明海豹平臺運維中心提供的研發(fā)平臺,提供框架、公共基礎組件、公共業(yè)務組件加速業(yè)務的日常研發(fā)工作1.2參考文檔海豹平臺WIKI:http://wiki.seals.webdev.com/1.3目的本規(guī)范由編程原則組成,融合并提煉了開發(fā)人員長時間積累下來的成熟經驗,意在幫助形成良好一致的編程風格。以達到事半功倍的效果,如果有需要本文檔會不定期更新。1.4適用范圍如無特殊說明,以下規(guī)則要求完全適用于基于海豹平臺框
5、架開發(fā)的應用,同時也可大部分適用于部門其他PHP項目。1.5標準化作用技術資料專業(yè)分享WORD文檔可編輯當一個軟件項目嘗試著遵守公共一致的標準時,可以使參與項目的開發(fā)人員更容易了解項目中的代碼、弄清程序的狀況。使新的參與者可以很快的適應環(huán)境,防止部分參與者出于節(jié)省時間的需要,自創(chuàng)一套風格并養(yǎng)成終生的習慣,導致其它人在閱讀時浪費過多的時間和精力。而且在一致的環(huán)境下,也可以減少編碼出錯的機會。缺陷是由于每個人的標準不同,所以需要一段時間來適應和改變自己的編碼風格,暫時性的降底了工作效率。從使項目長遠健康的發(fā)展以及后期更高的團隊工作效率來考慮暫時的工作效
6、率降低是值得的,也是必須要經過的一個過程。標準不是項目成功的關鍵,但可以幫助我們在團隊協作中有更高的效率并且更加順利的完成既定的任務。1)程序員可以了解任何代碼,弄清程序的狀況2)新人可以很快的適應環(huán)境3)防止新接觸PHP的開發(fā)出于節(jié)省時間的需要,自創(chuàng)一套風格并養(yǎng)成終生的習慣4)防止新接觸PHP的開發(fā)一次次的犯同樣的錯誤5)在一致的環(huán)境下,可以減少犯錯的機會1目錄結構規(guī)范1.1框架路徑框架引用路徑必須采用絕對路徑,托管的開發(fā)、測試和正式環(huán)境必須為:/data/php/framework1.2應用目錄結構應用需要嚴格參考以下目錄安排代碼位置:webr
7、oot/index.phpWeb應用入口腳本文件index-test.php功能測試使用的入口腳本文件assets/包含公開的資源文件css/包含CSS文件images/包含圖片文件themes/包含應用主題protected/包含受保護的應用文件技術資料專業(yè)分享WORD文檔可編輯modc命令行腳本modc.batWindows下的命令行腳本modc.php命令行PHP腳本commands/包含自定義的'modc'命令components/包含可重用的用戶組件config/包含配置文件controllers/包含控制器的類文件SiteControl
8、ler.php默認控制器的類文件extensions/包含第三方擴展messages/包含翻譯過的消息(i8n相關)mod