PHP 註解筆記

在開發網頁的過程中
難免會需要中文註解
將來方便研究及維護

以下就以「宇宙戰記」專案註解為例

命名空間：
/**
* 管理中心 控制器
*
* PHP 版本 7.0+
*
* @package application\controllers\admin
* @author a950216t
* @copyright 2009～2017 宇宙戰記開發團隊
* @see https://xnova.tw
* @version 3.1.0
*/
namespace application\controllers\admin;

Class 類別：
/**
* 聯盟 類別
*
* @package application\controllers\admin\Alliances
* @author a950216t
* @copyright 2009～2017 宇宙戰記開發團隊
* @see https://xnova.tw
* @version 3.1.0
*/
class Alliances extends Controller

屬性：
/** @var int $_planet 被編輯的行星編號 */
private $_planet;

函式：
/**
* 取得各項資料
*
* @param string $type 資料種類：info（聯盟資訊）、ranks（聯盟權限）、members（聯盟成員）
*
* @return string
*/
private function get_data($type)