建議在開發規范的獨立的PHP項目時,使用規范的文件目錄結構,這有助于提高項目的邏輯結構合理性,對應擴展和合作,以及團隊開發均有好處。
一個完整獨立的PHP項目通常的文件和目錄結構如下:
`/` 項目根目錄
`/manage` 后臺管理文件存放目錄
`/css` css文件存放目錄
`/doc` 存放項目文檔
`/images` 所有圖片文件存放路徑(在里面根據目錄結構設立子目錄)
`/scripts` 客戶端js腳本存放目錄
`/tpl` 網站所有html的模版文件存放目錄
`/error.php` 錯誤處理文件(可以定義到apache的錯誤處理中)
以上目錄結構是通常的目錄結構,根據具體應用的具體情況,可以考慮不用完全遵循,但是盡量做到規范化。
- 1、編寫目的
- 2、整體要求
- 3、安全規范
- 3.1、包含文件
- 3.1.1、命名規則
- 3.1.2、存放規則
- 3.2、安全規則
- 3.3、一些針對PHP的規則
- 3.4、其它處理規則
- 3.4.1、輸入參數處理
- 3.4.2、操作大HTML文本
- 4、編碼規范
- 4.1、命名規范
- 4.1.1、變量命名
- 4.1.2、類命名
- 4.1.3、方法或函數
- 4.1.4、縮寫詞
- 4.1.5、數據庫表名
- 4.1.6、數據庫字段
- 4.2、書寫規則
- 4.2.1、代碼縮進
- 4.2.2、大括號{}書寫規則
- 4.2.3、小括號()和函數、關鍵詞等
- 4.2.4、=符號書寫
- 4.2.5、if else swith for while等書寫
- 4.2.6、類的構造函數
- 4.2.7、語句斷行
- 4.2.8、數字
- 4.2.9、判斷
- 4.2.10、避免嵌入賦值
- 4.2.11、錯誤返回檢測規則
- 4.3、程序注釋
- 4.3.1、程序頭注釋塊
- 4.3.2、類的注釋
- 4.3.3、函數和方法的注釋
- 4.3.4、變量或者語句注釋
- 4.4、其它規范
- 4.4.1、PHP代碼標記
- 4.4.2、程序文件名、目錄名
- 4.4.3、PHP項目通常的文件目錄結構
- 4.4.4、PHP和HTML代碼的分離問題
- 4.4.5、PHP項目開發中的程序邏輯結構
- 5、特定環境下PHP編碼特殊規范
- 5.1、變量定義
- 5.2、引用的使用
- 5.3、變量的輸入輸出