跳到主要內容

PHP 命名風格

PHP 的命名風格（Coding Style）

PHP 的學習與使用有蠻常的時間，近期的 PHP 更新使得這個語言融入其他語言的優點，在程式的特性上有些大躍進。近期閱讀 「現代PHP（Modren PHP）」 這本書，有種看完會更新整個使用 PHP 思維的感覺。書中有篇章在說明 PHP-FIG 的 PSR 建議標準，相同的使用規範能夠讓程式開發人員的程式互通性更好，合作性更佳，不再是悶着頭寫程式的時代，讓我們更容易的使用別人的輪子造車子。

其中 PSR-1 對於程式碼的風格有一些基礎的規範，回顧之前不同時期寫的程式，會發現自己在不同的學習階段，會依據當時查詢的風格規範而更改，每次都有一點小小的不同，這次決定記錄下來讓自己參考也與其他人交流。

變數命名

PSR-1 建議標準中，有針對類別、常數等建議命名原則，對於變數的名稱在 PSR-1 的內容中有提到沒有特別制定建議項目，之前觀察不同前輩的建議和查詢幾個有名的框架（Zend、Symfony、Laravel），寫下自己對變數名稱的命名。

  • 駝峰式命名法（camelCase），小寫字母開頭，後面每個單字的第一個字母大寫。
  • 要使用描述性的命名方式。
  • 迴圈變數通常使用: $i, $j, $k, …等等。
  • 存放 session 的變數前面以 sess 開頭。
  • 存放 cookie 的變數前面以 coke 開頭。
  • 臨時性的變數前面以 tmp 開頭。
  • $query 和 $result 這兩個變數只能用在 SQL 的查詢語法變數與查詢結果變數。
  • 項目名稱（option）全部使用小寫及使用底線 _ （underscore）分隔。
$defaultOptions = array(
    'some_default' => 'values',
    'another_default' => 'more values',
);

常數命名

  • 常數名稱完全採用大寫英文字母。【PSR-1】
  • 必要時使用底線 _ （underscore）來區分單字。【PSR-1】
  • 如果內容有可能會改變，應改採用變數而非常數。

類別命名

  • 必須使用大寫開頭的駝峰式命名（camelCase），又稱爲 TitleCase。【PSR-1】
  • extends 和 implements 關鍵字需和類別名稱在同一行。【PSR-2】

方法命名

  • 必須使用小寫開頭的駝峰式命名（camelCase）。【PSR-1】
  • 小寫字母開頭，後面每個單字的第一個字母大寫。【PSR-1】
  • 當參數的數量多長度超過最大值（80字）時，可以換行處理。換行後其他參數要縮排起始大括弧要在新的一行。【Zend 1】
public function bar($arg1, $arg2, $arg3,
    $arg4, $arg5, $arg6) 
{
    // all contents of function
    // must be indented four spaces
}

SQL語法

  • 以 $query 變數名稱來存放 SQL 的命令。當發生錯誤時可以容易找出問題的地方。
  • 所有 SQL 的關鍵字必須採用大寫英文字母。
  • SQL 的寫法要分行，幫助程式碼容易閱讀與了解。

檔案命名

  • 檔案名稱完全採用小寫英文字母。
  • 字與字之間使用底線 _ 連接（EX：show_table.php）。
  • 一定要使用 .php 作為副檔名。
  • 會被引入的設定內容以 .inc.php 結尾。
  • 檔名長度必須小於 32 個字元（符合舊式系統）。
  1. Zend Coding Style ↩
標籤：

留言

張貼留言

這個網誌中的熱門文章

Word的合併列印如何出現「千分位」符號

今天樓下的同事突然問我一個問題，合併列印的時候如何顯示「千分位符號」（逗號），就是12 , 300。在Excel我們可以很容易的為儲存格裡的數字加上千分位的標記，但是儲存格實際儲存的還是只有數字，那個千分位符號是Excel給我們看的一種「格式」。 當我們在Word裡使用Excel做好的報表來合併列印的時候，Word會最真實的將這個數字欄位給讀出來，呈現在合併列印的欄位數值裡，無論在Excel理事不是有設定千分位符號，在Word合併列印後卻沒有出現，所以我們同樣的必須給他加上格式。 Word裡加上格式並不如Excel裡按一下就完成，加上逗號的千分位格式方法如後： 1.在Word裡插入合併列印的欄位變數。 2.在變數上按滑鼠右鍵，選擇「切換功能變數代碼」（也可以直接按Alt+F9），變數會由 << 經費 >> 變成 { MERGEFIELD "經費" } 。 3.加上格式就是把 { MERGEFIELD "經費" } 在}前加入數字格式參數 /##,###，會成為 { MERGEFIELD "經費" /# ##,### }（這裡指定五位數，以此類推） #：這個格式項目會指定要在結果中顯示的必要位數；如果結果不含該位數的數字，則 Word 會顯示一個空格。 0：這個格式項目會指定要在結果中顯示的必要位數；如果結果不含該位數的數字，則 Word 會顯示 0 (零)。 4.預覽內容，就可以發現千分位（逗號）出現，如果數值有零的話，最好可以換成 /# ##,## 0 ，避免空格出現。 數字格式參數請參考 Microsoft Office Online 。
張貼留言
閱讀完整內容

在DOS下檔案名稱加上日期

由於要完成檔案自動備份的需求，以減少每日使用人工的麻煩，也可以避免人為疏失造成的遺漏，需要定時拷貝某個檔案至遠端，在檔名加上日期以避免檔案覆蓋的情形。由於近來接觸Linux較多，自然比較熟悉Linux的Shell語法，回到Windows裡卻想不到解決的方法。 開始使用電腦時，已經活生生的跳過了DOS的年代，雖然會使用Copy語法，卻不知怎麼加上系統日期，參拜估狗大師後得到了解答，使用%DATE%環境變數。 在DOS中使用date會顯示目前日期，但會要求輸入新的日期時間不符合需求，雖然加上"/T"不會詢問新時間，但因為date是指令無法使用在copy的語法中，所以我們使用%DATE%環境變數，所以在我們要加上日期的檔案上加上此環境變數：copy test.txt test_%DATE%.txt 結果並不如我們想像，使用echo看%DATE%的傳回值，會出現"2007/12/4"，使用於copy語法裡系統回應「命令語法不正確」，我們必須去除「/」的符號，這就需要用到環境變數的擴充功能了！ 用echo來測試： # echo %DATE:~0,4% ： 取環境變數%DATE%的值，由第一碼開始取四碼（可以取出"西元年"的值）。 # echo %DATE:~5,2% ：取環境變數%DATE%的值，由第六碼開始取二碼（可以取出"月"的值）。 # echo %DATE:~8,2% ：取環境變數%DATE%的值，由第九碼開始取二碼（可以取出"日"的值）。 原先的 #copy test.txt test_%DATE%.txt 要更改成 #copy test.txt test %DATE:~0,4% %DATE:~5,2% %DATE:~8,2% .txt 拷貝後的檔案為test_20071204.txt
張貼留言
閱讀完整內容

DOS下連線/中斷網路磁碟機

最近實在是不得不和DOS多一點親近，在Linux中我們可以mount遠端電腦NFS分享出來的資料夾來做存取，輕易的備份我們需要的資料後再unmount，很Easy~:) 原本想在Windows下更應該輕而易舉的完成「連線網路磁碟機」用來將資料備份至遠端的電腦（或是遠端儲存設備）。沒錯，的確可以簡單的連線網路磁碟機，但當我們設定排程自動執行批次檔（*.bat）來進行遠端備份的工作時，windows就發揮他暈倒的功力......很抱歉，登出以後，剛剛建立的「連線網路磁碟機」就自動"中斷"了，批次檔裡寫的檔案路徑形同無效路徑。 只好繼續參拜估狗大神，以期保佑永不當機...不對，是在DOS下連線到網路磁碟機啦！ DOS下我們要使用連線網路磁碟機，必須使用 net use 指令。 連線網路磁碟機： # net use x: \\ComputerName\ShareName "Password" / user: DottedDomain\UserName x ：要對應至本機磁碟的代號 \\ComputerName\ShareName ：遠端電腦及分享資料夾名稱 /user:DottedDomain\UserName ：連線使用者名稱 例如： # net use z: \\192.168.0.10\sharefolder 連線至192.168.0.10的sharefolder對應至本機的z磁碟 # net use z: \\192.168.0.10\sharefolder "test" /user:192.168.0.10\Jeffy 連線至192.168.0.10的sharefolder對應至本機的z磁碟，連線時使用"Jeffy"連線密碼為"test" 連線網路磁碟機後，及可以直接切換磁碟機代號進入遠端連線的資料夾，進行copy或其他指令動作，完成任務後再中斷網路磁碟。 中斷網路磁碟機： # net use x: /delete x ：連線的網路磁碟機代號 更詳盡的net use使用方式和參數請見 Microsoft Net use 。
張貼留言
閱讀完整內容