PHP编码规范

浏览:750次阅读
没有评论

提醒:本文最后更新于 2021-09-26 18:38,文中所关联的信息可能已发生改变,请知悉!

PHP 编码规范

1.  变量定义

变量名使用 小驼峰命名法,使用英文单词命名。例如:

$studentName =“张三”;

 

2.  赋值(=)

等号左右两边使用空格,例如:

$name =‘张三’;

 

3.  运算符

运算符左右两侧使用空格分隔。如:

$name & $age

$age | $sex

 

4.  流程控制语句

关键字后面可以不加空格,() 中的开始和结尾不用空格,但是里面的表达式和运算符前后使用空格,{} 不换行,例如:

if($name ==‘张三’){

         // 代码块

}

流程控制的语句块必须使用缩进。表现层级关系

 

5.  缩进

使用 4 个空格   而不是 TAB

如:

if($name ==‘张三‘){

   
// 代码块

}

 

6.  函数命名:

函数命名使用 小驼峰命名法 使用英文单词命名。
形参之间的, 号后面使用空格,{} 不换行,函数体必须使用缩进,表现代码的层级关系。如:

function studentInfo($name, $age){

   
// 函数体

}

 

7.  函数调用:

实参之间, 号后面使用空格分隔;如:

studentInfo(‘张三’, 18);

 

8.  类定义:

类定义使用 大驼峰命名法 首字母大写,以英文单词命名。{} 号需单独占一行。类要写上注释。如:

// 学生信息类

class StudentInfo

{

         // 类

}

 

9.  类属性

使用 大驼峰命名法,类的属性必须使用关键字进行修饰。类的所有属性必须使用缩进,表示层级关系。每一个类属性必须写上注释,表示作用。如:

class StudentInfo

{

         // 表示学生的姓名

         public
$Name;

         // 表示学生的年龄

         public
$Age;

}

 

10.  类方法

使用 大驼峰命名法,类的方法必须使用关键字进行修饰,方法需要缩进,表示层级关系,{} 不用独占一行,成员方法必须加上注释,表示其功能,如果有参数,需要写上参数的期望类型,如果有返回值,需要写上返回值的类型。如:

class StudentInfo

{

         /**                           

         * 获取学生姓名

         *
return @string 学生姓名

         */

         public
function GetStudentName(){

         // 方法体

         return $this->Name;

}

}

 

11. 注释

单行注释:// 后面跟一个空格,再写注释内容。如:

// 这里是单行注释

 

多行注释:格式

 

/**

* 注释内容

*/

 

12. 文档布局

多个类型的代码,应该写在不同的文件中。

变量的申明应该写上注释。多个之间要以空行隔开。如:

// 学生姓名

$studentName =‘张三’;

 

// 学生年龄

$studentAge = 19;

 

代码的每一行不应该超过 80 个字符。

 

 

13. 代码书写步骤。

先用注释将逻辑写出来,再写代码。如:

//>> 1. 第一步

if(){

}

//>> 2. 第二步

for(){}

//>> 3. 第三步

return $xxx;

正文完
 0
包子
版权声明:本站原创文章,由 包子 于2016-10-24发表,共计1256字。
转载说明:除特殊说明外本站文章皆由CC-4.0协议发布,转载请注明出处。
评论(没有评论)