檢視 Php程式碼撰寫標準規則 的原始碼
←
Php程式碼撰寫標準規則
跳至導覽
跳至搜尋
由於以下原因,您無權編輯此頁面:
您請求的操作只有這個群組的使用者能使用:
使用者
您可以檢視並複製此頁面的原始碼。
*主要參考的 Mantis 程式碼撰寫標準網址 : http://www.mantisbt.org/guidelines.php ==變數命名規則== *變數名稱完全採用小寫英文字母. *字與字之間使用 _ 來連接, 例如. $green_color_value *要使用描述性的命名方式 (迴圈變數可以例外). *迴圈變數通常使用: $i, $j, $k, …等等. *計算性的變數($bug 的總數)應以被計算的變數名稱($bug)後面接 _count 的格式來命名, 例如. $bug_count *全域性的變數前面應該加上 g_ *存放 session 的變數前面應該加上 sess_ *存放 cookie 的變數前面應該加上 cookie_ *臨時(temp)的變數前面應該加上 t_ *由網頁表單傳過來的參數和變數如果已經確認不含 SQL 特殊字元(例如 /) 前面應該加上 c_ *由網頁表單傳過來的函式參數如果不確認是否含 SQL 特殊字元(例如 /), 那前面應該加上 p_ *由網頁表單傳過來的變數如果不確認是否含 SQL 特殊字元(例如 /), 那前面應該加上 f_ *其他的變數前面應該加上 v_, v2_, …等等. *為了避免視覺上的混淆, 變數前面千萬不要加上 l_ 或 o_ 或 q_ . *$query 和 $result 這兩個變數只能用在 SQL 的查詢語法變數($query)與查詢結果變數($result) ==常數命名規則== *常數名稱完全採用大寫英文字母. *字與字之間使用 _ 來連接, 例如. ROOT_PATH *全域性的常數前面應該加上 G_ *如果內容有可能會改變(例如在管理介面提供更改設定內容值), 應改採用變數而非常數 ==函式(Functions)命名規則== *函式名稱完全採用小寫英文字母. *字與字之間使用 _ 來連接, 例如. setup_page_breaks() *函式名稱不應該超過五個有意義的英文字, 例如. setup_page_from_old_to_new() → setup_page_old_to_new() *列印功能的函式前面應該要加上 print_, 例如. print_page() *要儘量將功能有相關的函式加上相同的前置文字(可容易看出是相同群組的函式) 例如. email_, news_, … 等等. ==Classes 命名規則== *要採用 FirstLetterOfWordIsCaptilized 的樣式 *屬於 class 物件內的變數, 前面應該要加上 m_ ==檔案命名規則== *檔案名稱完全採用小寫英文字母. *字與字之間使用 _ 來連接, 例如. view_new_bugs_page.php *要使用 .php 當副檔名 *檔名長度必須小於 32 個字元. 這樣才能相容一些較舊的檔案系統像是 Mac OS. *會被 Included 的檔案在檔名後面必須是 _inc.php *預設的參數檔案在檔名後面加上 .default 例如. config_inc.php.default ==SQL 格式== *所有 SQL 的關鍵字必須採用大寫英文字母: <sql> $query = "SELECT * FROM $g_mantis_bug_table WHERE id='1'"; </sql> *要以 $query 這特殊變數來存放 SQL 的命令. 這樣當發生錯誤時可以很容易找出問題的地方. *SQL 的寫法要分行, 這樣才能讓程式碼變的容易閱讀與了解. ==一般通用格式== *使用 TABS 來分出層次 <php> : <TAB>if ( is_array( gpc_get( 'show_category', null ) ) ) { <TAB><TAB>$f_show_category = gpc_get_string_array( 'show_category', META_FILTER_ANY ); <TAB>} else { <TAB><TAB>$f_show_category = gpc_get_string( 'show_category', META_FILTER_ANY ); <TAB><TAB>$f_show_category = array( $f_show_category ); <TAB>} : </php> *在 php 程式碼前後要以 <?php ?> 這樣式來撰寫 <php> : <?php require_once( 'core.php' ) ?> <?php auth_ensure_user_authenticated() ?> <?php $f_type = gpc_get_int( 'type', -1 ); : ?> </php>
返回到「
Php程式碼撰寫標準規則
」。
導覽選單
個人工具
建立帳號
登入
命名空間
頁面
討論
臺灣正體
視圖
閱讀
檢視原始碼
檢視歷史
更多
搜尋
導覽
首頁
近期變更
隨機頁面
MediaWiki說明
工具
連結至此的頁面
相關變更
特殊頁面
頁面資訊