PHP 命名规范

Question

3.1. 类

3.1.1. 类名称

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

如：Name、SuperMan、BigClassObject。

3.1.2. 类属性

属性名命名采用驼峰命名法（首字母小写，后续单词首字母大写），私有属性使用'_'开始。

如：$tablePrefix，$_tablePrefix

3.1.3. 类方法和函数名称

• 方法的作用都是执行一个动作，达到一个目的。所以名称应该说明方法是做什么的。一般名称的前缀都是有第一规律的，如 is, get, set。
• 方法的的命名采用驼峰命名法（首字母小写，后续单词首字母大写）， 如：getUserName(), parseLayout()
• 私有方法、函数，使用带有下划线的形式，如 _func()

3.1.4. 方法中参数

• 参数命名采用驼峰命名法（首字母小写，后续单词首字母大写）。如：

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

3.2. 变量和常量

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

如：$msg_error、$chk_pwd 等

3.2.1. 引用变量

• 引用变量要带有‘r’(recommend) 前缀。如：

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

3.2.2. 全局变量

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

3.2.3. 常量

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

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

3.2.4. 全局常量

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

  station $sStatus = 1;
  

3.2.5. 静态变量

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

  function this_good_idear(){
      ...
  }
  

3.3. PSR-0 vs PSR-4

PSR，PHP Standards Recommendations。为自动加载而服务。目前官方已经废弃了 PSR-0，但是发现 composer 还是对 PSR-0 向下兼容，从 composer 的加载代码中了解了一下他们的区别： https://getcomposer.org/doc/04-schema.md#psr-4