我們在平常寫**或看別人寫的**時, 在方法的說明注釋中經常會有這樣的注釋:
/**
* @param $num
* @return array
*/
注釋標記用於生成文件, param指明需要接收的引數, return指明返回值
在使用 phpdocumentor 等工具生成文件時, 會識別相關注釋, 而且ide也會識別, 在編碼的過程中會給出提示.
@author
標明作者
/*
* @author hujing * hujing: 作者名
* [email protected]: 郵箱
*/
@deprecated
標明方法是不建議使用的、已過期的或將要刪除的
/*
* 語法:
* @deprecated [版本號] [描述]
* eg:
* @see class::test()
* @deprecated 2.0 將被棄用,請使用test方法
*/
會繼承父類文件, 且子類出現衝突文件時重寫父類文件
@internal
標識此類或方法僅限當前檔案使用
@description [描述]
@link
指明外部鏈結, 必須給出完整url
@link [url] [描述]
@see
此鏈結不光可以跳轉到外部鏈結, 還可以跳轉到內部的指定方法等, 如: class::method
@see [url|內部方法] [描述]
@var
定義資料的型別
@var [型別] [變數名] [描述]
/**
* 可以指定變數的型別
* @var array 名稱列表
* 也可以指定變數名, 指定變數時陣列或空
* @var array|null $namelist 名稱列表
*/
@throws
丟擲異常
@throws [型別] [描述]
@method
類注釋, 標明該類可以呼叫的方法, 可以令ide自動提示等
/**
* @method string test(int num) 測試方法
*/
標識引數資訊, 型別可參考 @var
@param [型別] [名稱] [描述]
@property
類屬性, 指明可以直接訪問與修改的類屬性, 私有屬性需要通過 __get
__set 魔術方法設定與訪問, 型別參考 @var
@property [型別] [名稱] [描述]
@property-read
類屬性, 指明唯讀的類屬性, 私有屬性需要通過 __get 魔術方法訪問, 型別參考 @var
@property-write
類屬性, 指明只寫的類屬性, 私有屬性需要通過 __set 魔術方法設定, 型別參考 @var
@return
標識方法的返回值, 型別參考 @var
@return [型別] [描述]
@global
標明用到的全域性變數
@global [型別] [名稱] [描述]
@ignore
標明生成文件是忽略的值
@users
標明使用到了哪些值
/**
* @users class::$num 使用此屬性計數
*/
注釋標記 body標記 字型標記 段落標記
1 注釋 瀏覽器能讀的到，但不會顯示出來 2 網頁主體標記body vlink 訪問過的文字顏色 alink 啟用的鏈結文字顏色 leftmargin 左邊界 rightmargin 右邊界 topmargin 上邊界 bottommargin 下邊界 3 字型修飾 1 標記文字 顏色 英文名稱 十...
html標記整理
5 無序列表 6 定義列表 定義列表 定義列表 定義列表 定義列表 定義列表 定義列表 7 預編排保持文字原來的格式 8 分割槽塊文字可以包含段落 標題 等 9 跨越多個字元 行內元素 保持同行，一行併排顯示 11 建立超連結 1.html title 超連結 name clj accesskey ...
PHP入門 標記 注釋 分隔符 變數 常量
常量區分php指令碼的標記 asp標記 基本棄用 php 短標記 基本棄用 指令碼標記 php注釋分為兩種 行注釋 一次注釋一行 塊注釋 一次注釋多行 單行注釋 與 作用一樣都是當行注釋 塊注釋 版本 echo hello world 語句分隔符 在每個語句結束時，使用 分割，讓系統可以明白語句的斷...