PHP代码规范

PHP编码规范:链接,做为一个PHP程序员,在协同开发中代码规范尤为重要,下文介绍如何使用编辑器帮助我们写出符合PSR规范的代码。

本文以Sublime为开发平台,介绍PHP代码规范自动检测工具的安装步骤。各工具都有多种安装方法,以下方法是兼容Unix/Win平台的一种通用安装方法

使用到的工具:

  • Sublime 编辑器
  • Phpfmt 代码格式化工具 (官方建议使用PHP5.5以上版本)
  • PHP CodeSniffer(Phpcs) 代码规范检测工具

Sublime的重要配置项:

  • 使用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

粘贴如下内容:

{
    "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规范对代码进行格式化,但还会有一些错误提示:命名空间、类名驼峰、文件注释等,需要再手动修复这些错误后保存。

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

以上代码最后有一个空行,发帖的时候被自动去掉了