<optgroup id="n2h1f"><li id="n2h1f"></li></optgroup>

  1. <span id="n2h1f"><sup id="n2h1f"></sup></span>

  2. <span id="n2h1f"></span>
    <optgroup id="n2h1f"></optgroup>

  3. 注釋規范

    • 2020-08-03 14:22:00
    • 閱讀次數:
    • 作者:盈嵐科技小編
    • 來源:http://www.guangzhoukeyan.com

    做網站中,不寫不必要的注釋,只有當代碼不能很好地說明邏輯時,才用注釋補充;把注釋看成程序的一部分,在編寫/維護代碼時同時編寫/維護注釋;注釋完全采用PHPDocumentor的規范,以方便用其生成API級文檔。下面給出各個部分的注釋示范。

    1. 文件頭注釋注釋包括以下方面。

    (1)項目、模塊名稱,文件名稱、功能說明。

    (2)模塊或文件的使用說明。

    (3)作者、日期。

    (4)修改記錄。

    示范:

    <?php/***************************************** 項目名稱:ZMedia 數據抓取服務* 文件名稱:ZMedia-Spider.php* 文件功能:服務運行入口****************************************** 運行方式:php ./ZMedia-Spider.php [-s] [控制信號] [-d]* 參數說明:* -s 控制信號:start(開始運行)、stop(結束運行)、restart(重新啟動)* -d 調試狀態,終端窗口顯示輸出調試信號,否則無窗口運行輸出到日志** 如:php ./ZMedia-Spider.php -s restart -d debug******************************************* 創建日期:2015-05-01* 創建作者:張三****************************************** 修改記錄:* 2015-05-01,V1.0,創建文件****************************************/

    2. 類注釋

    注釋包括以下方面。

    (1)類名稱。

    (2)作者、日期。

    (3)修改記錄。

    示范:

    <?php/****************************************** 文件功能:日志記錄類****************************************** 創建日期:2015-05-21* 創建作者:張三****************************************** 修改記錄:* 2015-05-21,V1.0,創建文件****************************************/

    3. 函數/類方法注釋

    注釋包括以下方面。

    (1)函數/類方法的功能說明。

    (2)輸入參數說明。

    (3)輸出結果說明。

    (4)(可選)實現流程說明。

    示范:/************************************************************ 功能:PHP截取UTF-8字符串,解決半字符問題。* 說明:英文、數字(半角)為1字節(8位),中文(全角)為3字節************************************************************* 輸入:$str 源字符串* $len 左邊的子串的長度* 輸出:取出的字符串,當$len小于等于0時,會返回整個字符串************************************************************/function utf-substr($str, $len)

    當前文章標題:注釋規范

    當前URL:http://www.guangzhoukeyan.com/news/wzzz/3252.html

    上一篇:PHP編碼規范

    下一篇:表單結構

    網站建設、抖音推廣、頭條推廣、微信朋友圈推廣、快手推廣專線:15368242187(微信同號)
    国产成本人片无码免费网站_在线人成免费视频69国产_91玖玖re精品国产_国产在线观看精品91