php 代码规范

最新推荐文章于 2023-05-06 12:09:19 发布

文杰_prise

最新推荐文章于 2023-05-06 12:09:19 发布

阅读量248

点赞数

分类专栏： php

php 专栏收录该内容

18 篇文章

订阅专栏

1. 各参数均需检测合法性

2. 接口返回格式

array(
    'state' => $state,  //0错误，1正确或http状态码
    'msg' => $msg,
);

3. if else 写法
if (1 == $a) {
    echo 1;
} else {
    echo 2;
}
注意各处空格，括号中变量放置右边，常量放置左边 
if后加空格，else/else if  前后加空格，elseif 分开写作else if
4. 方法定义： 
名字足够准确，空格+大括号
function test() {
    //方法中大括号前加空格
    //方法名与小括号之间不能有空格
}
5.类定义 
名字足够准确，空格+大括号class A {
   //类中大括号前加空格

}
6. 等号左右两端加空格
7. => 左右两端加空格
8. 逗号后边跟空格或换行
$a = array(1, 2, 3);
9. 不嵌入变量的情况下，使用单引号 $a = ‘test’
10. 连接符 . 左右两边都加空格
11. 在 “switch” 语句中应该总是包括 “default” 控制。
12. 当使用 array 类型符声明关联数组的时候，我们鼓励把它分成多个行，只是我们必须同时保证每行的键与值的对齐，以保持美观。
$sampleArray = array(
    'firstKey'  => 'firstValue',
    'secondKey' => 'secondValue'
);
13. 当类成员方法被声明为 private 时，必须分别以双下划线 “_”为开头；被声明为 protected 时，必须分别以单下划线 “” 为开头；一般情况下的方法不含下划线。
class Foo {
    private function __example() {
        // ...
    }
    protected function _example() {
        // ...
    }
    public function example() {
        // ...
    }
}
14. 被声明为 private的类成员属性必须由双下划线 “_” 作为开头；被声明为 protected 的类成员属性必须由下划线 “” 作为开头；而声明为 public 的成员属性则在任何时候都不允许含有下划线。
15. 对于对象成员的访问，虽然可以直接访问，但建议使用 “get” 和 “set” 方法。
class Foo {
    protected $_testObj;
    public function getTestObj() {
        return $this->_testObj;
    }
    public function setTestObj($testObj) {
        $this->testObj = $_testObj;
    }
}
16. 类文件都是以“.class.php“为后缀，且类文件名只允许字母，使用驼峰法命名，并且首字母大写 
例如： DbMysql.class.php