PHP编码规范的深入探讨


Posted in PHP onJune 06, 2013

缩进与空白字符(Indenting and Whitespace)
使用 2 个空格而不使用 tab 键进行代码缩进(notepad++, Eclipse 等编辑器均支持此项配置);
行尾不应该有空白字符
应使用 \n (Unix换行符),而不是 \r\n (Windows 换行符)
所有文件均应以一个空行结尾

运算符(Operators)
所有二元运算符(二个值之间的运算符),如 +, -, =, !=, ==, > 等等,在运算符两端均需留有一个空格,如应该使用 $foo = $bar 而不是 $foo=$bar。
所有一元运算符(只操作一个值班的运算符),例如 ++,在值与运算符之间则不应加入空格

转型(Casting)
在 (type) 与要转型的变量之间应加入一个空格,如 (int) $mynumber.
控制结构(Control Structures)
控制结构包含 if, for, while, switch 等等,下面是一个简单的 if 语句结构示例:

if (condition1 || condition2) {
  action1;
}
elseif (condition3 && condition4) {
  action2;
}
else {
  defaultaction;
}

(Note: 不要使用 "else if" -- 总是使用 elseif.)
控制语句的关键词与左边括号之间应该有一个空格,以此来与函数调用进行区分。
即使在大括号是可选的情况下,也应当总是使用大括号。这样可以加强代码的可读性以及减少因嵌套带来的逻辑错误。
switch 语句结构示例:
switch (condition) {
  case 1:
    action1;
    break;
  case 2:
    action2;
    break;
  default:
    defaultaction;
}
do-while 语句结构示例:
do {
  actions;
} while ($condition);

行长度与封装(Line length and wrapping)
通常情况下,每行代码的长度不应超过80个字符
以下情况,行长度可超过80个字符:当行内包含过长的函数名称、函数/类定义、变量声明等
为方便阅读和理解,控制结构的行长度可超过80个字符
  if ($something['with']['something']['else']['in']['here'] == 
mymodule_check_something($whatever['else'])) {
    ...
  }
  if (isset($something['what']['ever']) && $something['what']['ever'] > $infinite 
&& user_access('galaxy')) {
    ...
  }
  // Non-obvious conditions of low complexity are also acceptable, but should
  // always be documented, explaining WHY a particular check is done.
  if (preg_match('@(/|\\)(\.\.|~)@', $target) && strpos($target_dir, $repository) 
!== 0) {
    return FALSE;
  }

控制条件(condition)不应该写作多行
控制条件应该适当拆分以便于阅读和理解,编写代码时要避免以下情形:
// DON'T DO THIS!
if ((isset($key) && !empty($user->uid) && $key == $user->uid) || (isset($user-
>cache) ? $user->cache : '') == ip_address() || isset($value) && $value >= time()))
{
  ...
}

将控制条件进行拆分,不仅便于阅读,同时也方便添加注释让人知道为何进行这样的条件判断
// Key is only valid if it matches the current user's ID, as otherwise other
// users could access any user's things.
$is_valid_user = (isset($key) && !empty($user->uid) && $key == $user->uid);
// IP must match the cache to prevent session spoofing.
$is_valid_cache = (isset($user->cache) ? $user->cache == ip_address() : FALSE);
// Alternatively, if the request query parameter is in the future, then it
// is always valid, because the galaxy will implode and collapse anyway.
$is_valid_query = $is_valid_cache || (isset($value) && $value >= time());
if ($is_valid_user || $is_valid_query) {
  ...
}

函数调用(Function Calls)
调用函数时,函数名与左括号之间没有空格,除最后一个参数外,每个参数后的 , 都应跟上一个空格,如:
$var = foo($bar, $baz, $quux);
如之前所说,等号两边应该各有一个空格。当有一系列相关语句时,出于可读性的考虑,可以适当增加空格的数量,如:
$short         = foo($bar);
$long_variable = foo($baz);

函数声明(Function Declarations)
包含默认值的参数应当放在最后,当函数拥有返回值时,尽量返回便于理解的值:

function funstuff_system($field) {
  $system["description"] = t("This module inserts funny text into posts randomly.");
  return $system[$field];
}

类构造器调用(Class Constructor Calls)
当调用不带参数的类构造器时,始终包含括号
$foo = new MyClassName();

带参数的类构造器
$foo = new MyClassName($arg1, $arg2);
如果使用变量做为类名,需先为变量赋值,然后才调用类构造器:

$bar = 'MyClassName';
$foo = new $bar();
$foo = new $bar($arg1, $arg2);

数组(Array)
数组的值之间应使用空格分隔,赋值操作符号(=>)左右也应包含空格:
$some_array = array('hello', 'world', 'foo' => 'bar');
当声明数组的字符长度超过80个字符(通常在构造表单和菜单时),应该将各元素分行、缩进编写:
$form['title'] = array(
  '#type' => 'textfield',
  '#title' => t('Title'),
  '#size' => 60,
  '#maxlength' => 128,
  '#description' => t('The title of your node.'),
);

注意:最后一个数组元素末尾有一个逗号,这并不是手误,而是避免有新元素加入到最后之后因缺少逗号而出现解析错误。(从某种程度上来讲,在最后一个数组元素末尾加上逗号是一种推荐的做法,甚至在向drupal.org提交代码时,一些代码规范检测脚本会因为最后一个元素没有添加逗号而出现警告提示。)

引号(Quotes)
Drupal 对于单引号和双引号的使用并没有很强硬的标准,只需在同一模块内保持用法的统一即可。
使用单引号的效率要高于双引号,因为解析器不需要到引号之间查找变量。以下是使用双引号的两种情况:
引号中间带有变量,如"<h2>$header</h2>"
引号中间带有单引号,使用双引号可避免对单引号的转义 "He's a good person." 当然也可以使用单引号,但 .pot 解析器不能很好的处理这种情况,而且看起来怪怪的'He\'s a good person.'

字符串连接(String Concatenations)
在点与要连接字符串之间需要加入空格以加强代码可读性:
如果只是简单地连接变量,可以使用双引号
使用连接赋值符(.=)时,需要在符号两侧预留空格

注释(Comment)
注释规范单独在 Doxygen及注释格式规范页面 讨论

引入代码(Including Code)
任何无条件引用文件的情况下,使用 require_once(), 任何有条件引用文件的情况,则使用 include_once(). 这两条语句都会保证文件只被引入一次。
当从当前目录或子目录引入代码时,始终以点路径开头
include_once ./includes/mymodule_formatting.inc
在 Drupal 7 及更新版本中,使用 DRUPAL_ROOT 常量:
require_once DRUPAL_ROOT . '/' . variable_get('cache_inc', 'includes/cache.inc');
PHP 代码标签(PHP Code Tags)
始终使用<?php ?>来界定PHP代码而不使用要<? ?>。这是为了遵循Drupal规范,同时也便于代码在其它系统和平台中被引用。
自 Drupal 4.7 开始,最后的 ?> 都故意被忽略不写,原因如下:
移除它可以避免在文件末尾出现空白字符,这些空白字符可能导致“文件头已发送(header already sent)”错误,XHTML/XML验证错误,及其它问题
PHP 官方说明 结尾的PHP界定符是可选项
PHP.net 自身也移除了文件末尾的界定符(如 prepend.inc )

分号(Semicolons)
PHP 语言要求除了代码块以外,大多数行尾都要跟上分号。Drupal 代码规范同样有此要求,并且对于代码块也是如此。以下是一个单行代码块的示例:
 -- YES
 -- NO
示例 URL(Example URL)
使用 example.com 表示所有示例 URLs
命名规范(Naming Conventions)
函数与变量(Functions and Variables)
函数与变量名称应该使用小写字母,且单词之间使用下划线分隔。函数应该使用模块组/模块名称作为前缀,以避免与不同模块间的冲突。
持久变量(Persistent Variables)
持久变量是指通过 variable_get()/variable_set() 函数取得和设置的变量,变量名称应该使用小写字母,且单词之间使用下划线进行分隔。持久变量也应该使用模块组/模块名称作为前缀,以避免与不同模块间的冲突。

常量(Constants)
常量始终要求使用全大写字母,且单词之间使用下划线进行分隔。(包括PHP内置常量 TRUE, FALSE, NULL)
模块中定义的常量需始终使用大写的模块名称作为前缀。
在 Drupal 8 及之后,应使用 const 关键词代替 define() 函数来定义常量,因为效率更高
注意 const 不能用于PHP表达式,因此在条件判断和非字面值(non-literal value ???)时,还是应当使用 define() 函数

全局变量(Global Variables)
定义全局变量时,应当使用下划线加模块/主题名称开头
类(Class)
类名应使用驼峰式命名(即单词首字母大写)

类中的方法(函数)和属性(成员变量)应使用首字母小写的驼峰式

定义访问权限时,使用 protected 而代替 private,从而其它的类可以在必要时扩展和更新方法。Protected 和 public 函数和变量不应以下划线开头。
更多关于 面向对象的编码规范
文件名(Filename)
所有文档文件都应加上 .txt 后缀,以便于 Windows 用户查看。同时,所有文件名称应该全部大写,而文件后缀应该全部小写。
如 README.txt, INSTALL.txt, TODO.txt, CHANGELOG.txt 等等。

辅助模块及工具
Coder 模块:可以遵循部分以上代码规范,对代码进行审查及修改建议
Drupal Code Sniffer :代码规范检测工具
PAReview.sh :还处理沙盒中的代码规范检测脚本,几乎严格遵守以上所有代码规范并给出修改建议。

PHP 相关文章推荐
Zend Studio for Eclipse的java.lang.NullPointerException错误的解决方法
Dec 06 PHP
javascript,php获取函数参数对象的代码
Feb 03 PHP
php文件打包 下载之使用PHP自带的ZipArchive压缩文件并下载打包好的文件
Jun 13 PHP
windows的文件系统机制引发的PHP路径爆破问题分析
Jul 28 PHP
php修改指定文件后缀的方法
Sep 11 PHP
PHP模板引擎Smarty内建函数详解
Apr 11 PHP
PHP GD库相关图像生成和处理函数小结
Sep 30 PHP
PHP实现的统计数据功能详解
Dec 06 PHP
Zend Framework路由器用法实例详解
Dec 11 PHP
php无限级评论嵌套实现代码
Apr 18 PHP
laravel 修改.htaccess文件 重定向public的解决方法
Oct 12 PHP
aec加密 php_php aes加密解密类(兼容php5、php7)
Mar 14 PHP
PHP输出XML到页面的3种方法详解
Jun 06 #PHP
PHP转换文件夹下所有文件编码的实现代码
Jun 06 #PHP
利用PHP实现图片等比例放大和缩小的方法详解
Jun 06 #PHP
PHP删除目录及目录下所有文件的方法详解
Jun 06 #PHP
解决PHP超大文件下载,断点续传下载的方法详解
Jun 06 #PHP
探讨PHP函数ip2long转换IP时数值太大产生负数的解决方法
Jun 06 #PHP
php IP转换整形(ip2long)的详解
Jun 06 #PHP
You might like
无需重新编译php加入ftp扩展的解决方法
2013/02/07 PHP
php实现的css文件背景图片下载器代码
2014/11/11 PHP
基于jQuery的图片剪切插件
2011/08/03 Javascript
FF火狐下获取一个元素同类型的相邻元素实现代码
2012/12/15 Javascript
用js读、写、删除Cookie代码续篇
2014/12/03 Javascript
js图片卷帘门导航菜单特效代码分享
2015/09/10 Javascript
nodejs 的 session 简单使用
2016/06/06 NodeJs
jQuery EasyUI框架中的Datagrid数据表格组件结构详解
2016/06/09 Javascript
基于vue2.0实现的级联选择器
2017/06/09 Javascript
微信小程序点击控件修改样式实例详解
2017/07/07 Javascript
Angular+Bootstrap+Spring Boot实现分页功能实例代码
2017/07/21 Javascript
解决vue 打包发布去#和页面空白的问题
2018/09/04 Javascript
在AngularJs中设置请求头信息(headers)的方法及不同方法的比较
2018/09/04 Javascript
浅谈js中的bind
2019/03/18 Javascript
Emberjs 通过 axios 下载文件的方法
2019/09/03 Javascript
Windows下安装 node 的版本控制工具 nvm
2020/02/06 Javascript
解决vue无法侦听数组及对象属性的变化问题
2020/07/17 Javascript
Vue实现一种简单的无限循环滚动动画的示例
2021/01/10 Vue.js
Python实现简单过滤文本段的方法
2017/05/24 Python
python基础练习之几个简单的游戏
2017/11/10 Python
Matplotlib 生成不同大小的subplots实例
2018/05/25 Python
python爬取网页转换为PDF文件
2018/06/07 Python
python pandas.DataFrame选取、修改数据最好用.loc,.iloc,.ix实现
2018/06/11 Python
使用Python的SymPy库解决数学运算问题的方法
2019/03/27 Python
Python读取xlsx文件的实现方法
2019/07/04 Python
使用pth文件添加Python环境变量方式
2020/05/26 Python
使用python求斐波那契数列中第n个数的值示例代码
2020/07/26 Python
详解numpy1.19.4与python3.9版本冲突解决
2020/12/15 Python
Kiehl’s科颜氏西班牙官方网站:源自美国的植物护肤品牌
2020/02/22 全球购物
公务员年总结的自我评价
2013/10/25 职场文书
工商学院毕业生自荐信
2013/11/12 职场文书
大学新生欢迎词
2014/01/10 职场文书
英文导游词
2015/02/13 职场文书
孔子观后感
2015/06/08 职场文书
优秀创业计划书分享
2019/07/19 职场文书
Java并发编程之原子性-Atomic的使用
2022/03/16 Java/Android