PHP程式員函數注釋規格(麻煩大家遵守)

來源:互聯網
上載者:User

以前我也不願意寫注釋,但是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){...}

 

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.