PHP代码常用注释规范（PHP Doc）

PHP代码常用注释规范（PHP Doc）

介绍几个常用的PHP注释

在PHP文件中使用该注释格式开始进行文件注释：

/**
 * @author 作者
 * @copyright 版权信息
 * @version 版本
 * 等等
 */
复制代码

---

描述一个类的注释：

/**
 * Class 类名
 * @package 命名空间
 * 等等
 */
复制代码

---

描述类的方法：

/**
 * @access public|protected|private
 * @param 类型 变量名 参数描述
 * @return 类型 变量名 返回数据描述
 */
复制代码

例如公共函数：

/**
 * @param string $time
 * @return false|int
 * 将Y-m-d H:i:s 格式字符串时间转换成UNIX时间戳
 */
function timeStampStringToUNIXStamp($time){
	return strtotime($time);
}
复制代码

---

描述类的属性：

/**
 * @var 类型 变量名 描述
 */
复制代码

---

例如获取微信接口的AccessToken在PHP中类似JavaBean类：

<?php
/**
 * @author Sylar Daemon
 * @version 1.0
 *
 */

namespace Home\Model;


/**
 * Class AccessToken
 * @package Home\Model
 */
class AccessToken
{
    /**
     * @var string $id 在数据库中id 
     */
    private $id ;
    
    /**
     * @var string $access_token 获取到的access_token
     */
    private $access_token;
    
    /**
     * @var string $end_time 销毁时间UNIX时间戳格式
     */
    private $end_time;
    
    /**
     * @var class $instance 这里使用单例模式
     */
    private static $instance = null;
    
    /**
     * @return AccessToken|class
     */
    public function getInstance(){
        if (self::$instance == null){
            self::$instance = new AccessToken();
        }
        return self::$instance;
    }
    
    /**
     * AccessToken constructor.
     */
    private function __construct(){
    	$this->id = null;
    	$this->access_token = null;
    	$this->end_time = null;
    }
    
    /**
     * @return string
     */
    public function getId()
    {
    	return $this->id;
    }
    
    /**
     * @param string $id
     */
    public function setId($id)
    {
    	$this->id = $id;
    }
    
    /**
     * @return string
     */
    public function getAccessToken()
    {
    	return $this->access_token;
    }
    
    /**
     * @param string $access_token
     */
    public function setAccessToken($access_token)
    {
    	$this->access_token = $access_token;
    }
    
    /**
     * @return string
     */
    public function getEndTime()
    {
    	return $this->end_time;
    }
    
    /**
     * @param string $end_time
     */
    public function setEndTime($end_time)
    {
    	$this->end_time = $end_time;
    }
}复制代码