php注釋前面 php標準注釋寫法

2021-10-22 23:00:50 字數 783 閱讀 8202

php標準注釋的寫法:

* @name  名字

* @abstract  申明變數/類/方法

* @access  指明這個變數、類、函式/方法的訪問許可權

* @author  函式作者的名字和郵箱位址

* @category  組織packages

* @const  指明常量

* @deprecate  指明不推薦或者是廢棄的資訊

* @example  示例

* @exclude  指明當前的注釋將不進行分析,不出現在文擋中

* @final  指明這是乙個最終的類、方法、屬性,禁止派生、修改。

* @global  指明在此函式中引用的全域性變數

* @include  指明包含的檔案的資訊

* @module  定義歸屬的模組資訊

* @modulegroup  定義歸屬的模組組

* @package  定義歸屬的包的資訊

* @param  定義函式或者方法的引數資訊

* @return  定義函式或者方法的返回資訊

* @see  定義需要參考的函式、變數,並加入相應的超級連線。

* @since  指明該api函式或者方法是從哪個版本開始引入的

* @static  指明變數、類、函式是靜態的。

* @throws  指明此函式可能丟擲的錯誤異常,極其發生的情況

* @todo  指明應該改進或沒有實現的地方

* @var  定義說明變數/屬性。

* @version  定義版本資訊

php注釋前面 PHP注釋種類有哪些

php 注釋 comments 有兩種型別 一種是單行注釋,一種是多行注釋。在一行中所有 符號右面的文字都被視為注釋,因為 php 解析器忽略該行 右面的所有內容。示例如下 也可以一行只寫注釋,不寫 如下 php 多行注釋語法 php 多行注釋以 開頭,以 結束。在 和 之間,可以寫多行注釋。示例如...

php注釋前面 PHP如何進行注釋

在 中進行注釋是很有必要的,規範的注釋使的源 更易於人類理解,可以幫助我們理解別人或者自己以前編寫的 那麼如何進行 注釋?本篇文章就來給大家介紹在php中進行注釋的幾種方法,希望對大家有所幫助。在php中可以進行兩種型別的注釋 單行注釋 每行必須單獨使用注釋標記,稱為單行注釋。它用於進行簡短說明。單...

php注釋標準

4.1 塊注釋 塊注釋通常用於提供對檔案,方法,資料結構和演算法的描述。塊注釋被置於每個檔案的開始處以及每個方法之前。它們也可以被用於其他地方,比如方法內部。在功能和方法內部的塊注釋應該和它們所描述的 具有一樣的縮排格式。塊注釋之首應該有乙個空行,用於把塊注釋和 分割開來,比如 這裡是塊注釋 塊注釋...