PHP注释语法规范和命名规范]

PHP注释规范

注释在写代码的过程中非常重要，好的注释能让你的代码读起来更轻松，在写代码的时候一定要注意注释的规范。

php里面常见的几种注释方式：

1.文件的注释，介绍文件名，功能以及作者版本号等信息

/**
* 文件名简单介绍
*
* 文件功能
* @author  作者
* @version  版本号
* @date  2020-02-02
*/

2.类的注释，类名及介绍

/**
* 类的介绍
*
* 类的详细介绍（可选）
* @author  作者
* @version  版本号
* @date  2020-02-02
*/

3.函数的注释，函数的作用，参数介绍以及返回类型

/**
* 函数的含义说明
*
* @access  public
* @author  作者
* @param mixed $arg1  参数一的说明
* @param mixed $arg2  参数二的说明
* @return array  返回类型
* @date  2020-02-02
*/

PHP命名规范

1.目录和文件

目录使用小写+下划线

类库，函数文件统一以.php为后缀

类的文件名均以命名空间定义，并且命名空间的路径和类库文件所在路径一致

类文件采用驼峰法命名（首字母大写），其他文件采用小写+下划线命名

类名和类文件名保持一致，统一采用驼峰法（首字母大写）

2.函数和类，属性命名

类的命名采用驼峰法（首字母大写），例如 User、UserType，默认不需要添加后缀，例如UserController应该直接命名为User

函数的命名使用小写字母和下划线（小写字母开头）的方式，例如 get_client_ip

方法的命名使用驼峰法（首字母小写），例如 getUserName(如果方法有返回值，那么目前习惯上将首字母用小写的属性类型，如s(string)，i(int)，f(float)，b(boolean)，a(array)等)

属性的命名使用驼峰法（首字母小写），例如 tableName、instance（目前习惯上将首字母用小写的属性类型，如s(string)，i(int)，f(float)，b(boolean)，a(array)等）

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

3.常量和配置

常量以大写字母和下划线命名，例如 APP_PATH和 THINK_PATH

配置参数以小写字母和下划线命名，例如 url_route_on 和url_convert

4.数据表盒字段

数据表和字段采用小写加下划线方式命名，并注意字段名不要以下划线开头，例如 think_user 表和 user_name字段，不建议使用驼峰和中文作为数据表字段命名。