欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  php教程

PHP命名规范

程序员文章站 2023-12-22 22:01:46
...

以下文字全部摘自《PHP从入门到精通》这本书,谨以此作为标准。 就一般约定而言,类、函数和变量的名字应该是能够让代码阅读者能够容易地知道这些代码的作用,应该避免使用凌磨两可的 命名 。 1. 类 命名 使用大写字母作为词的分割,其他的字母均使用小写。

以下文字全部摘自《PHP从入门到精通》这本书,谨以此作为标准。

就一般约定而言,类、函数和变量的名字应该是能够让代码阅读者能够容易地知道这些代码的作用,应该避免使用凌磨两可的命名

1. 类命名

  • 使用大写字母作为词的分割,其他的字母均使用小写。
  • 名字的首字母使用大写。
  • 不要使用下划线('_')。

如:Name、SuperMan、BigClassObject。

2. 类属性命名

属性名命名采用驼峰命名法(首字母小写,后续单词首字母大写),私有属性使用'_'开始。如:$tablePrefix,$_tablePrefix

3. 类方法命名

方法的作用都是执行一个动作,达到一个目的。所以名称应该说明方法是做什么的。一般名称的前缀都是有第一规律的,如is(判断)、get(得到),set(设置)。

方法的的命名采用驼峰命名法(首字母小写,后续单词首字母大写), 如:getUserName()\ parseLayout()

4. 方法中参数命名

参数命名采用驼峰命名法(首字母小写,后续单词首字母大写)。如

class EchoAnyWord{
    function echoWord($firstWord, $secondWord){
        ...
    }
}

5. 变量命名

  • 所有字母都使用小写。
  • 使用‘_’作为每个词的分界

如:$msg_error、$chk_pwd等。

6. 引用变量

引用变量要带有‘r’前缀。如:

class Example{
    $mExam = "";
    funciton SetExam(&$rExam){
        ...
    }
    function $rGetExam(){
        ...
    }
}

7. 全局变量

全局变量应该带有前缀‘g’。如:global = $gTest、global = $g。

8. 常量、全局常量

常量、全局常量,应该全部使用大写字母,单词之间用‘_’来分割。如

define('DEFAULT_NUM_AVE',90);
define('DEFAULT_NUM_SUM',500);

9. 静态变量

静态变量应该带有前缀‘s’。如:

station $sStatus = 1;

10. 函数命名

所有的名称都使用小写字母,多个单词使用‘_’来分割。如:

function this_good_idear(){
    ...
}

参考:PHP命名规则

上一篇:

下一篇: