PHP程式設計師函式註釋規格(麻煩大家遵守)

y0umer發表於2013-01-15

以前我也不願意寫註釋,但是2個月後發現自己寫的什麼都不知道了..

為了宇宙的發展,為了二次開發的便捷,為了程式碼的可讀性,建議大家把註釋寫好..

<?php
/**
* @name 名字
* @abstract 申明變數/類/方法
* @access 指明這個變數、類、函式/方法的存取許可權
* @author 函式作者的名字和郵箱地址
* @category  組織packages
* @copyright 指明版權資訊
* @const 指明常量
* @deprecate 指明不推薦或者是廢棄的資訊MyEclipse編碼設定
* @example 示例
* @exclude 指明當前的註釋將不進行分析,不出現在文擋中
* @final 指明這是一個最終的類、方法、屬性,禁止派生、修改。
* @global 指明在此函式中引用的全域性變數
* @include 指明包含的檔案的資訊
* @link 定義線上連線
* @module 定義歸屬的模組資訊
* @modulegroup 定義歸屬的模組組
* @package 定義歸屬的包的資訊
* @param 定義函式或者方法的引數資訊
* @return 定義函式或者方法的返回資訊
* @see 定義需要參考的函式、變數,並加入相應的超級連線。
* @since 指明該api函式或者方法是從哪個版本開始引入的
* @static 指明變數、類、函式是靜態的。
* @throws 指明此函式可能丟擲的錯誤異常,極其發生的情況
* @todo 指明應該改進或沒有實現的地方
* @var 定義說明變數/屬性。
* @version 定義版本資訊
*/
function XXX($a){...}

 


相關文章