寫出規範化的高可讀性的函數代碼註釋
阿新 • • 發佈:2018-07-22
cat const myeclipse 方法的參數 規範 group 一個 定義 right
對代碼接觸的越多,我越來越想讓寫出的代碼更加perfect,更加高可讀性,其中各個函數的代碼註釋就是非常關鍵的一步:
/**
* 函數功能
* @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 指明此函數可能拋出的錯誤異常,極其發生的情況
* @var 定義說明變量/屬性。
* @version 定義版本信息
*/
寫出規範化的高可讀性的函數代碼註釋