您的位置 首页 php

给程序员的PHP编码规范建议

文件格式

1. 对于只含有 php 代码的文件,我们将在文件结尾处忽略掉 “?>” 。这是为了防止多余的空格或者其它字符影响到代码。

例如:

<?php

$foo = ‘foo’;

2. 缩进应该能够反映出代码的逻辑结果,尽量使用四个空格,禁止使用制表符TAB,因为这样能够保证有跨客户端编程器软件的灵活性。

例如:

if (1 == $x) {

$indented_code = 1;

if (1 == $new_line) {

$more_indented_code = 1;

}

}

3. 变量赋值必须保持相等间距和排列。

例如:

$variable = ‘demo’;

$var = ‘demo2’;

4. 每行代码长度应控制在80个字符以内,最长不超过120个字符。因为 linux 读入文件一般以80列为单位,就是说如果一行代码超过80个字符,那么系统将为此付出额外操作指令。这个虽然看起来是小问题,但是对于追求完美的程序员来说也是值得注意并遵守的规范。

5. 每行结尾不允许有多余的空格。

代码书写规范

文件夹的命名:

文件夹同一使用小写字母。如存放控制器的文件夹,直接命名为controller即可

文件的命名:

如果是类文件的话,那么文件的命名应该同类名称保持一致,统一使用大驼峰。如 Session .class.php , 对应类名称为Session,

如果是普通的工具脚本,那么统一使用小驼峰,如common.php

类名称的命名:

类名称同一使用大驼峰,Cookie类

方法名的命名:

统一使用小驼峰,一般使用 动词 + 名次 的形式来描述该方法的功能,如 sendMessage ,发送短信。

在面向对象中,遵循同样的规则,但是个别地方有所区别:

?

123 public getUserName() protected _getTotalAmount() private _setBlanceAmount()

变量的命名规范:

关于变量,我们需要多说几点:

1、无论在面向对象还是非面向对象的语法中,变量统一使用小驼峰,如:$workYears。

但是在面向对象中又有所不同,public 、 protected 、 private ,protected或者private属性的时候,前面加上了 _ 作为区别

?

12345 public $startPosition = 1;protected $_salaryAmount =1000;private $_sex = ‘formale’;

2、如果是常量的话,统一使用大写,中间使用下划线进行分割。

?

123 define(‘CURRENT_SCRIPT’, ‘index.php’);const TRANSACTION_TYPE = ‘income’;

3、 全局变量 ,使用大驼峰,前缀加上 _ ,所有的单词首字母大写。因为知道一个变量的作用域是非常重要的,所以 局部变量 和全局变量应该很明显的进行分开!

$_System_Config;

$_Root_Path;

缩进符

关于 编码 的缩进符号,我们统一使用制表符缩进!也许有的人会问为什么不适用空格缩进的呢?

原因很简单,大部分的编辑器都支持制表符等于多少个空格,而使用空格就没得调了!

运算符号

所有的两元运算符号,都应该前后使用空格进行

?

12 $name = ‘zero’;$age > 18 ? ‘ adult ‘ : ‘children’;

常见的流程语句规划

我们约定,所有的流程语句的花括号都单独占据一行。理由:如果遇到较为复杂的业务逻辑,花括号会出现很多的嵌套,这样一来我们会混淆个个对应的花括号!

文本标记

所有PHP文件,其代码标记均使用完整的PHP标签,不建议使用短标签,例如:

[php] view plaincopy

<span style=”font-family:Microsoft YaHei;font-size:18px;”><?PHP

Echo ‘hello world!’;

?>

<?</span>

[php] view plaincopy

<span style=”font-family:Microsoft YaHei;font-size:18px;”><span style=” white-space : pre “> </span>//不建议使用

Echo ‘not suggest’;

?></span>

使用短标签格式容易和XML混淆,并且不是所有的PHP版本和服务器都默认支持或打开短标签选项。

对于只含有PHP代码的文件,将在文件结尾处忽略’?>’,这是为了防止多余空格或者其他字符影响到代码。

文章来源:智云一二三科技

文章标题:给程序员的PHP编码规范建议

文章地址:https://www.zhihuclub.com/150238.shtml

关于作者: 智云科技

热门文章

网站地图