PHP代碼規範

PHP編碼規範:連接,作爲一個PHP程序員,在協同開發中代碼規範尤其重要,下文介紹如何使用編輯器幫助咱們寫出符合PSR規範的代碼。javascript

本文以Sublime爲開發平臺,介紹PHP代碼規範自動檢測工具的安裝步驟。各工具都有多種安裝方法,如下方法是兼容Unix/Win平臺的一種通用安裝方法

使用到的工具:php

  • Sublime                              編輯器
  • Phpfmt                               代碼格式化工具  (官方建議使用PHP5.5以上版本)
  • PHP CodeSniffer(Phpcs)       代碼規範檢測工具


Sublime的重要配置項:java

  • 使用4個空格代替tab
            Sublime配置: View->Indentation,勾選"Indent Using Spaces"和"Table width:4"
  • Line Endings: Unix 
            Sublime配置: View->Line Endings,勾選"Unix"
  • 使用不帶BOM的UTF-8編碼
            Sublime默認配置便可;其它編輯器須要設置


工具安裝流程:
1: 將php添加到系統環境變量中(建議使用PHP5.5以上版本)。安裝Sublime\Packages contro
2: 在電腦上安裝PHP CodeSniffer:
        下載PHP_CodeSniffer,將文件解壓到電腦的某個目錄(確保之後不會被誤刪除掉)
3: 安裝Sublime插件:點擊Preferences->Browse Packages到包目錄。
        下載phpfmt到當前目錄,重命名爲phpfmt
        下載PHP_CodeSniffer到當前目錄,重命名爲Phpcs

附:
phpfmt配置項:
        打開配置文件:Preferences->Packages Settings->Phpfmt->Settings Default
        粘貼以下內容:git

{
    "autocomplete": true,
    "enable_auto_align": true,
    "format_on_save": true,
    "indent_with_space": true,
    "passes":
    [
            "MergeElseIf"
    ],
    "psr2": true,
    "version": 2
}

  

Phpcs配置項:
        打開配置文件:Preferences->Packages Settings->PHP CodeSniffer->Settings Default
        搜索「phpcs_executable_path」,修改值爲:
                windows  : 將其值設置爲{第二步保存文件的目錄}/script/phpcs.bat
                類Unix系統: 將其值設置爲{第二步保存文件的目錄}/script/phpcs
                注意,目錄要用「/"分隔


測試是否安裝成功:
   輸入代碼:程序員

<?php
class demo {
 
}
echo "hello"
 
?>

        保存時會自動檢測到代碼語法錯誤,手動修復後再保存會自動按照PSR2規範對代碼進行格式化,但還會有一些錯誤提示:命名空間、類名駝峯、文件註釋等,須要再手動修復這些錯誤後保存。
github

<?php
namespace Test;
 
class Demo
{
 
}
echo "hello";

以上代碼最後有一個空行,發帖的時候被自動去掉了windows

相關文章
相關標籤/搜索