• <bdo id="o2qm2"><center id="o2qm2"></center></bdo>
  • <bdo id="o2qm2"><center id="o2qm2"></center></bdo>
    <bdo id="o2qm2"><center id="o2qm2"></center></bdo>
  • 400電話 400-660-7376
    知識庫_柳州依米軟件科技有限責任公司
    軟件定制_柳州依米軟件科技有限責任公司網站建設_柳州依米軟件科技有限責任公司APP開發_柳州依米軟件科技有限責任公司微信營銷_柳州依米軟件科技有限責任公司
  • 咨詢電話
  • 0772-8256510
  • 聯系QQ
  • 732570672
  • 手機號碼
  • 18577274336
  • E-mail
  • oa@www.plainfield-homeinspector.com
  • 當前位置:首頁知識庫

    團隊開發,你的代碼寫好規范了嗎?

    來源:原創    作者:依米科技    時間:2014-08-27

    在網站建設和軟件項目開發中,每個寫代碼的程序員都有著自己的編碼習慣,

    因此,養成良好的代碼注釋習慣有助于自己回顧代碼時檢查錯誤,這種習慣使你的團隊更加受益。

    我們來看看使用PHP語言開發項目中的代碼注釋規范。


    1、文件注釋

    在每一個PHP文件的頭部注釋,通常含有對此PHP文件的簡述、詳細功能描述、版權、作者、修改時間等信息,如:

    // +----------------------------------------------------------------------

    // | Lzyim_CMS [ 依米科技內容管理系統 為追求卓越的產品而不懈努力 ]

    // +----------------------------------------------------------------------

    // | Copyright (c) 2013-2023 http://www.www.plainfield-homeinspector.com All rights reserved.

    // +----------------------------------------------------------------------

    // | Author: lzyim <oa@www.plainfield-homeinspector.com>

    // +----------------------------------------------------------------------


    2、類注釋

    類注釋一般包含類說明、歸屬的包等

    /**

     * 模型擴展 

     * @category   Extend

     * @package    Extend

     * @subpackage Model

     * @author   lzyim <oa@www.plainfield-homeinspector.com>

     */


    3、類方法注釋

    一般包括類說明、指明函數/方法的存取權限、參數信息、返回信息等

    /**

     * 動態方法實現

     * @access public

     * @param string $method 方法名稱

     * @param array $args 調用參數

     * @return mixed

     */


    下面附上常用PHPDoc屬性注解

    /**

     * @name 名字

     * @abstract 申明變量/類/方法

     * @access 指明這個變量、類、函數/方法的存取權限

     * @author 函數作者的名字和郵箱地址

     * @category 組織packages

     * @copyright 指明版權信息

     * @const 指明常量

     * @deprecate 指明不推薦或者是廢棄的信息

     * @example 示例

     * @exclude 指明當前的注釋將不進行分析,不出現在文擋中

     * @final 指明這是一個最終的類、方法、屬性,禁止派生、修改。

     * @global 指明在此函數中引用的全局變量

     * @include 指明包含的文件的信息

     * @link 定義在線連接

     * @module 定義歸屬的模塊信息

     * @modulegroup 定義歸屬的模塊組

     * @package 定義歸屬的包的信息

     * @param 定義函數或者方法的參數信息

     * @return 定義函數或者方法的返回信息

     * @see 定義需要參考的函數、變量,并加入相應的超級連接。

     * @since 指明該api函數或者方法是從哪個版本開始引入的

     * @static 指明變量、類、函數是靜態的。

     * @throws 指明此函數可能拋出的錯誤異常,極其發生的情況

     * @todo 指明應該改進或沒有實現的地方

     * @var 定義說明變量/屬性。

     * @version 定義版本信息

     */


    本文鏈接:http://www.plainfield-homeinspector.com:80/repository/599,轉載請保留出處!
    本站部分圖文來源網絡,如有侵權請您聯系我們刪除,謝謝。
      聯系我們
    wechatcode
    wechatico官方微信公眾號
    weibocode
    weiboico新浪官方微博
    wanganico

    桂公網安備 45029002000034號

    備案號:桂ICP備13005335號-1

    展開
    精品视频日韩伦三
  • <bdo id="o2qm2"><center id="o2qm2"></center></bdo>
  • <bdo id="o2qm2"><center id="o2qm2"></center></bdo>
    <bdo id="o2qm2"><center id="o2qm2"></center></bdo>