php注釋標準

2022-08-23 06:03:12 字數 786 閱讀 6350

/*

** @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注釋標準

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

PHP標準注釋

php是一門及其容易入門的語言,剛入門的新手不到幾分鐘的時間可能就會用echo列印出乙個hello world 但是他是真正的程式設計師嗎?怎麼來定義程式設計師呢?如果想真正成為乙個程式設計師,那麼就必須遵循一套程式書寫規範,我們經常編寫一些函式,但是這些函式可能也只有自己能看得懂,甚至過一段時間自...

PHP標準注釋

2018 12 14 14 08 網頁設計 標籤 php 425 2 php是一門及其容易入門的語言,剛入門的新手不到幾分鐘的時間可能就會用echo列印出乙個hello world 但是他是真正的程式設計師嗎?怎麼來定義程式設計師呢?如果想真正成為乙個程式設計師,那麼就必須遵循一套程式書寫規範。我們...