PHP编程源代码常见注释规范讲解？

* @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 2019-09-05
*/

文件头部模板

/** 
*这是一个什么文件 
* 
*此文件程序用来做什么的（详细说明，可选。）。 
* @author richard 
* @version $Id$ 
* @since 1.0 
*/

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

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

/** 
* 类的介绍 
* 
* 类的详细介绍（可选。）。 
* @author richard<858560031@qq.com> 
* @since 1.0 
*/

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

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

头部注释

/** 
* some_func 
* 函数的含义说明 
* 
* @access public 
* @param mixed $arg1 参数一的说明 
* @param mixed $arg2 参数二的说明 
* @param mixed $mixed 这是一个混合类型 
* @since 1.0 
* @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.数据表盒字段

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

（编辑：晋中站长网）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!