在PSR基础上自定义的代码命名规范

根据PSR基础规范和PHP100知名讲师张恩民的PHP教学视频进行整理,所有命名禁止使用阿拉伯数字。

目录、文件和局部变量

  • 使用英文名词、动词,所有字母均使用小写,以下划线作为单词的分隔。

    目录:upload,templates,install
    文件:index.php,config.php
    变量:$pay_time,$user_name,$article_del_time
    

全局常量

  • 使用英文名词、动词,所有字母均使用大写,以下划线作为单词的分隔。

      define('WEBSITE_NAME','erchoc');
      define('WEBSITE_URL','http://www.erchoc.com');
    

数组变量

  • 使用英文名词、动词,以下划线作为单词的分隔。

  • 所有字母均使用小写,以_array结束。

      $scopr_array = array();
      $book_id_array = array();
    

对象变量

  • 使用英文名词、动词,以下划线作为单词的分隔,可以完整采用类名或者简化类名,但是必须明确知道是什么类。

  • 所有字母均使用小写,以_obj结束。

    $user_obj = new userAccount();
    $pay_obj = new payOrder();
    

类的命名

  • 使用英文名词,以大写字母作为词的分隔,其他字母均使用小写。

  • 名词的首个字母小写,类名不使用下划线。

    class userAccount{......}
    

方法命名

  • 使用英文名词、动词,所有字母均使用小写,以下划线作为单词的分隔。

  • 对象属性的命名同理。

    class userCar{
      public $user_name = 'Erchoc';
      public function account_price_car() {
        ......
      }
      public function add_user_car() {
        ......
      }
     }
    

函数、符号和运算符规范

  • switch的每个case块都要换行再加上break,而default必须存在以处理特殊情况。

    switch() {
      case 'user':
        ......
      break;
      case 'type':
        ......
      break;
      default:
        ......
      break;
    }
    
  • 声明定位风格:变量的代码块必须等于号对其,且初次使用变量必须初始化。

    $tableName   = '';
    $user_article = '';
    

尽量避免下面的做法:

  $tableType;
  $get_bookArticle = '';
  $user_show = '';

其他基础规范

  • 除书写SQL和需要加入变量的时候使用双引号,其他尽可能使用单引号代替双引号。

  • PHP文件中尽可能不出现HTML语句,尤其是使用模板开发,考虑到模板兼容性,HTML文件中也尽可能减少PHP代码。

  • 通常每个方法只完成一个特定的功能(逻辑动作事务),所以方法的命名要能清楚说明它的用处,例如使用email_error_check()代替email_chenk(),用pay_error_check()代替pay_chenk()

  • 自定义方法和变量名不能与系统方法和变量冲突。

  • HTML的form表单各元素的name和数据库字段名或者PHP接受变量一致,或者在字段名的基础上团队确定表单元素名添加前缀或者后缀。

  • HTML的form表单不要采用缺省方法bool值判断非零数值,必须如下显式测试。

    if($user_pay_num != false) {
       ......
    }
    

各种注释的规范

  • 流程控制和无参函数在实现前使用单行注释,需要特别说明的行在行尾添加单行跟踪注释。
    //用户检测
    if($check_obj->username( $username ) == true){......}
    $user_name = $_POST['username'];//获取用户信息
  • 多参数方法注释:
    /**
    * 分页预处理函数
    * sql SQL语句
    * page 当前页数
    * limit 每页现实的数量
    * maxs 查询总数
    */
    function page_limit($sql, $page='0', $limit=10, $maxs=''){
    ......
    }

数据库设计与操作规范

  • 数据库名称使用英文小写,以下划线分隔单词,以免跨平台时出现的大小写错误。
  • 数据表名称应该由物体对象名称的小写字母组成,以下划线分隔单词。并尽可能对应系统中业务类的名称,如laravel框架的数据表名称为Model类的复数小写形式。
  • 数据表的字段避免使用varchar和text等不定长的数据。
  • 查询多表连接数据时候要求使用全名称或者别名,即使用tableName.fieldName代替fieldName
  • SQL语句应尽可能符合ANSI92标准,避免使用T-SQL或者PL-SQL等特定数据库对SQL语言的扩充特性。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,265评论 6 490
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,078评论 2 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 156,852评论 0 347
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,408评论 1 283
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,445评论 5 384
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,772评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,921评论 3 406
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,688评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,130评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,467评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,617评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,276评论 4 329
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,882评论 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,740评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,967评论 1 265
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,315评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,486评论 2 348

推荐阅读更多精彩内容