帮助中心

命名规范

发布日期:2013-03-24 发布人:周立峰

PHP命名规范(帮助记忆版本)

======================================================================

  类名:类的文件名及类名保持一致(包括大小写),采用驼峰命名法,首字母大写。

  属性名:用驼峰法命名,并且首字母小写。如:tableName

  类的方法:用驼峰法命名,并且首字母小写。如:getUserInfo()

  工具函数:函数的命名使用小写字母和下划线的方式,例如 get_client_ip

  变量名:变量名应该只包含小写字母,用下划线分隔 如:$table_name

  常量名:以大写字母和下划线命名,例如 HAS_ONE和 MANY_TO_MANY

  数据表名:用小写加下划线方式命名,例如 users

  表字段名:用小写加下划线方式命名,例如 user_name

  目录命名: 全部小写 例如:admin cache config language library

  接口定义:以大I开头,采用驼峰命名法,首字母大写 例如:IProduct.php 

  实现接口:以Impl结尾,采用驼峰命名法,首字母大写 例如:ProductImpl.php 


对于只包含有 PHP 代码的文件,结束标志("?>")是不允许存在的,PHP自身不需要("?>"),

这样做, 可以防止它的末尾的被意外地注入相应。 

缩进由四个空格组成,禁止使用制表符 TAB 。

常量必须通过 "const" 定义为类的成员,强烈不鼓励使用 "define" 定义的全局常量。

以双下划线“__”打头的函数或方法作为魔法方法,例如 __call 和 __autoload

字符串文字 

当字符串是文字(不包含变量),应当用单引号( apostrophe )来括起来: 

$a = 'Example String';
                    
包含单引号(')的字符串文字 

当文字字符串包含单引号(apostrophe )就用双引号括起来,特别在 SQL 语句中有用: 

$sql = "SELECT `id`, `name` from `people` WHERE `name`='Fred' OR `name`='Susan'";

在转义单引号时,上述语法是首选的,因为很容易阅读。 

禁止SQL语句采用select * from abc 要查询的字段必须带上 其他操作类似比如:插入等。

变量替换 

变量替换有下面这些形式: 

$greeting = "Hello $name, welcome back!";

$greeting = "Hello {$name}, welcome back!";

注释模板

/**
 * MainOneCMS 铭万开源CMS内容管理系统  (http://cms.b2b.cn)
 *
 * 文件用途说明
 * 
 * 这里写类的详细说明,这里写类的详细说明,这里写类的详细说明,这里写类的详细说明。
 * 这里写类的详细说明,这里写类的详细说明。
 * 
 * 文件修改记录:
 * <br>周立峰  ${date} ${time} 创建此文件 
 * 
 * @author     周立峰 <zhoulifeng@mainone.cn>  ${date} ${time}
 * @filename   ${file}  ${encoding} 
 * @copyright  Copyright (c) 2004-${year} Mainone Technologies Inc. (http://www.b2b.cn)
 * @license    http://cms.b2b.cn/license/   MainOneCMS 1.0
 * @version    SVN: $$Id$$
 * @link       http://cms.b2b.cn 
 * @link       http://www.b2b.cn
 * @package    ${class_container}
 * @since      1.0.0
 */