PHP代码中的常用注释

/**

* @name 名字

* @abstract 申明变量/类/方法

* @author 函数作者的名字和邮箱地址

* @copyright 指明版权信息

* @const 指明常量

* @global 指明在此函数中引用的全局变量

* @include 指明包含的文件的信息

* @package 定义归属的包的信息

* @param 定义函数或者方法的参数信息

* @return 定义函数或者方法的返回信息

* @since 指明该api函数或者方法是从哪个版本开始引入的

* @static 指明变量、类、函数是静态的。

* @var 定义说明变量/属性。

* @version 定义版本信息

*/

例子:

/**

* 函数的含义说明

*

* @access public

* @param mixed $arg1 参数一的说明

* @param mixed $arg2 参数二的说明

* @param mixed $mixed 这是一个混合类型

* @return array 返回类型

*/

程序代码注释:

1、#是一种简短的注释方法,可用它去注释一个变量,或者调用的一个方法。

具体到某一个语句的注释,可以使用行尾注释://。

块注释可以使用/* */方式,/**/可能还在用它去注释掉一大段代码。

2、注释的原则是将问题解释清楚,并不是越多越好。

3、一个好的命名本身就是注释,而且是好的注释。

  • 发表于:
  • 原文链接https://kuaibao.qq.com/s/20181011B0W29J00?refer=cp_1026
  • 腾讯「云+社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。
  • 如有侵权,请联系 yunjia_community@tencent.com 删除。

扫码关注云+社区

领取腾讯云代金券