PHP程式設計師函式註釋規格(麻煩大家遵守)
以前我也不願意寫註釋,但是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){...}
相關文章
- 所有程式設計師都應該遵守的 11 條規則程式設計師
- java中須遵守的程式設計風格Java程式設計
- 每一個程式設計師要遵守的一些優秀程式設計風格程式設計師
- 程式設計師應該遵守的程式設計原則程式設計師
- PHP程式碼常用註釋規範(PHP Doc)PHP
- Google C++ 程式設計風格指南:註釋GoC++程式設計
- 每個程式設計師都必須遵守的程式設計原則程式設計師
- PHP陷入麻煩:核心人物加入PHP基金會PHP
- 【程式設計師之最佳註釋-人人都是昏析師】程式設計師
- Google C++程式設計風格指南(六):程式碼註釋GoC++程式設計
- 趣味橫生的程式設計師搞怪程式碼註釋程式設計師
- bash程式設計 註釋程式設計
- 程式設計師的十大煩惱程式設計師
- Golang 註釋規範-類、函式、結構體等Golang函式結構體
- 函數語言程式設計(一) 認識“程式設計正規化”和“函式”函數程式設計函式
- [程式設計] 你真的會寫函式註釋?這裡給你一個答案程式設計函式
- PHP程式設計師的技術成長規劃PHP程式設計師
- php程式設計師該如何規劃自己的人生PHP程式設計師
- PHP 程式設計師的技術成長規劃PHP程式設計師
- php程式碼註釋PHP
- 程式設計師應該避免的5種程式碼註釋程式設計師
- 程式設計師是否有義務做好程式碼的註釋?你做好程式碼註釋了嗎?程式設計師
- 糟糕程式設計師的程式設計風格程式設計師
- 函式程式設計函式程式設計
- 優秀的程式設計師真的不寫註釋嗎?程式設計師
- 21個奇葩註釋,程式設計師看了都點贊程式設計師
- 好程式設計師web前端教程:Math函式程式設計師Web前端函式
- 好程式設計師學習筆記:函式程式設計師筆記函式
- 註釋之重——程式設計師與程式碼可維護性程式設計師
- 匹配css程式碼註釋的正規表示式CSS
- 優化函數語言程式設計:向PHP移植Clojure函式優化函數程式設計PHP函式
- Python 的函式註釋Python函式
- 好程式設計師Python培訓分享函數語言程式設計之匿名函式程式設計師Python函數函式
- PHP程式設計師危機PHP程式設計師
- PHP程式設計師面試題PHP程式設計師面試題
- CORBA的麻煩事... (轉)ORB
- 麻煩各位高手幫忙
- scala 函式程式設計函式程式設計