1. 縮排方式
a) 以層次方式縮排,使用tab鍵tab(4個字元)的縮排,不可使用空格縮排,tab設定時不要使用空格填充。
2. 語義分隔
a) 各個類、函式、方法之間應該採用空行間隔;
b) 同乙個函式中聯絡緊密的語句之間可以不換行,其他情況需要換行;**中處理同一內容的語句與其它語句間使用空行。
3. 空格規則
a) 邏輯運算符號前後應加空格(++ -- 不需如此) 如 $a == $b $a++ $a--;
b) 多個引數分隔時應加空格如: $userid, $parentid ; finduserinfo($userid, $parentid)
c) 語法關鍵字後應加空格如:for ($i=0; $i<100; $i++)
4. 命名
a) 變數命名應遵循大駝峰規範,並且命名有意義,意有所指。
如:$username $userid 而不是 $user_id $level_3 $a_b 等等這種方式
推薦先定義後使用。
b) 函式命名一樣需要遵循大駝峰命名並書寫詳細的函式文件說明,宣告返回型別
/** * 附件快取key
* @param int $id
* @return string
*/public static function getfiledatakey($id)
c) 類名大駝峰
d) 類屬性可以使用下劃線開頭如 :protected $_isvalid
5. sql 規範
a) sql欄位命名時候應避免使用mysql關鍵字如 limit order 等
b) 到店專案表以 ts_ 為字首欄位名命名如:user_id 保持統一
c) 資料庫中,庫名、表名、欄位名禁止使用sql關鍵子,所有庫名、表名、欄位名均使用小寫字母表示,名字中不能有空格;
d) 在php中嵌入的sql語句關鍵字全部採用大寫; 資料值兩邊用單引號『』包括,sql語句遵循標準sql格式,並且應確保資料值中的單引號已經轉義以防止sql注入。
e) 查詢欄位用 ``包括 sql
$sql=」select`username`fromuserwhereid=』$id』」;
6. 注釋規範
a) 檔案頭部
在每個檔案頭部加上該檔案功能的簡單介紹,作者,時間等,如果該檔案是類檔案時,則寫類注釋。
b) 類定義注釋
i. 定義類時應該加上注釋,描述該類大概實現的功能,作者,時間等;
ii. 類中的public與protected變數如不能明確表達意思時應該加上注釋;
iii. 類中的public與protected方法應該加上詳細注釋(功能,引數,返回值等);
iv. 使用inte***ce開發時,inte***ce方法加詳細注釋(功能,引數,返回值等),具體實現可以不寫。
v. 類中的private的方法複雜時也需要加上注釋,簡單實現可以不加。
c) 修改他人程式
i. 修改別人建立的檔案中的程式或增加的功能,加上作者,時間,注釋。
7. 快取key 命名
a) 目前系統使用memcache key 必須在cachekey靜態類中定義。
PHP程式設計常用技巧四則
1.配置php檔案目錄 作為伺服器端解釋執行的指令碼語言,php程式放置在某個伺服器可以訪問的目錄下,一般可以通過修改apache的進行配置,例如我們在該檔案中的一句 alias test d brhpwebsitebrhp 那麼在瀏覽器端輸入 http localhost test php檔名 就...
C 程式設計規範
1.簡介 1 1.1 基本原則 1 1.2 適用範圍 1 1.3 使用常識 1 1.4 參考資料 1 2.組織 2 2.1 專案組織風格 2 2.1.1 專案取名與最終的可執行檔名一致 2 2.1.2 專案目錄設定 2 2.2 整合環境內的專案目錄設定 3 2.3 檔案宣告 3 2.3.1 類宣告與...
C程式設計規範
沒有規矩,不成方圓 c 是.net中乙個功能強大的語言,這意味著你用c 可以編寫強大的程式,也可以產生一堆垃圾,在你沒有自信成為絕頂的高手 輕鬆駕馭c 這匹野馬之前,遵循一定的程式設計規範和標準起碼可以讓你和你的團隊輕鬆交流,並且和他們看起來保持同乙個水平。規範可以一定程度上保證軟體質量 保證專案進...