PHP注释语法规范与命名规范示例

/**
* @name 名字
* @abstract 申明变量/类/方法
* @access 指明这个变量、类、函数/方法的存取权限
* @author 函数作者的名字和邮箱地址
* @category 组织packages
* @copyright 指明版权信息
* @const 指明常量
* @deprecate 指明不推荐或者是废弃的信息
* @example 示例
* @exclude 指明当前的注释将不进行分析，不出现在文挡中
* @final 指明这是一个最终的类、方法、属性，禁止派生、修改。
* @global 指明在此函数中引用的全局变量
* @include 指明包含的文件的信息
* @link 定义在线连接
* @module 定义归属的模块信息
* @modulegroup 定义归属的模块组
* @package 定义归属的包的信息
* @param 定义函数或者方法的参数信息
* @return 定义函数或者方法的返回信息
* @see 定义需要参考的函数、变量，并加入相应的超级连接。
* @since 指明该api函数或者方法是从哪个版本开始引入的
* @static 指明变量、类、函数是静态的。
* @throws 指明此函数可能抛出的错误异常,极其发生的情况
* @todo 指明应该改进或没有实现的地方
* @var 定义说明变量/属性。
* @version 定义版本信息
*/

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

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

• 规范

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

• 示例

/** 
* 文件名介绍
* 
* 此文件是用来做什么的（可选） 
* @author   richard 
* @version   $Id$ 
* @since    1.0 
*/ 

2.类的正文，类名及引见

• 规范

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

• 示例

/** 
* 类的引见 
* 
* 类的详细引见（可选） 
* @author     richard 
* @since     1.0 
*/ 
class Test  
{ 
} 

3.函数的正文，函数的作用，参数引见和前往类型

• 规范

/**
* 函数的寄义阐明
* 
* @access public 
* @author 作者
* @param mixed $arg1 参数1的阐明 
* @param mixed $arg2 参数2的阐明
* @return array 前往类型
* @date 2020-02-02
*/

• 示例

/** 
* some_func 
* 函数的寄义阐明 
* 
* @access public 
* @param mixed $arg1 参数1的阐明 
* @param mixed $arg2 参数2的阐明 
* @param mixed $mixed 这是1个混淆类型 
* @since 1.0 
* @return array 
*/ 

public function thisIsFunction($string, $integer, $mixed)
{
    return array();
} 

顺序代码正文

1. 注释的原则是将问题解释清楚，并不是越多越好。

2. 若干语句作为一个逻辑代码块，这个块的注释可以使用/* */方式。

3. 具体到某一个语句的注释，可以使用行尾注释//。

/* 生成设置文件、数据文件。*/ 
 
$this->setConfig(); 
$this->createConfigFile(); //创立设置文件 
$this->clearCache();     // 肃清缓存文件 
$this->createDataFiles();  // 生成数据文件 
$this->prepareProxys(); 
$this->restart();

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字段，不建议运用驼峰和中文作为数据表字段命名。