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;
    }
}複製程式碼