每個程序頭部必須有統一的注釋塊,規則如下:
    a.必須包含本程序的描述;
    b.必須包含作者;
    c.必須包含書寫日期;
    d.必須包含版本信息;
    e.必須包含項目名稱;
    f.必須包含文件的名稱;
    g.重要的使用說明,如類的調用方法、注意事項等;
參考例子如下:
~~~
//
// +---------------------------------------------------------+
// | PHP version 4.0
// +---------------------------------------------------------+
// | Copyright (c) 1997-2001 The PHP Group
// +---------------------------------------------------------+
// | This source file is subject to of the PHP license,
// | that is bundled with this packafile LICENSE, and is
// | available at through the world-web at
// | http://www.php.net/license/2_02.txt.
// | If you did not receive a copy of the and are unable to
// | obtain it through the world-wide-web,end a note to
// | license@php.net so we can mail you a immediately.
// +---------------------------------------------------------+
// | Authors: Stig Bakken
// | Tomas V.V.Cox
//
// +———————————————————+
//
// $Id: Common.php,v 1.8.2.3 2001/11/13 01:26:48 ssb Exp $
~~~
- 1、編寫目的
- 2、整體要求
- 3、安全規范
- 3.1、包含文件
- 3.1.1、命名規則
- 3.1.2、存放規則
- 3.2、安全規則
- 3.3、一些針對PHP的規則
- 3.4、其它處理規則
- 3.4.1、輸入參數處理
- 3.4.2、操作大HTML文本
- 4、編碼規范
- 4.1、命名規范
- 4.1.1、變量命名
- 4.1.2、類命名
- 4.1.3、方法或函數
- 4.1.4、縮寫詞
- 4.1.5、數據庫表名
- 4.1.6、數據庫字段
- 4.2、書寫規則
- 4.2.1、代碼縮進
- 4.2.2、大括號{}書寫規則
- 4.2.3、小括號()和函數、關鍵詞等
- 4.2.4、=符號書寫
- 4.2.5、if else swith for while等書寫
- 4.2.6、類的構造函數
- 4.2.7、語句斷行
- 4.2.8、數字
- 4.2.9、判斷
- 4.2.10、避免嵌入賦值
- 4.2.11、錯誤返回檢測規則
- 4.3、程序注釋
- 4.3.1、程序頭注釋塊
- 4.3.2、類的注釋
- 4.3.3、函數和方法的注釋
- 4.3.4、變量或者語句注釋
- 4.4、其它規范
- 4.4.1、PHP代碼標記
- 4.4.2、程序文件名、目錄名
- 4.4.3、PHP項目通常的文件目錄結構
- 4.4.4、PHP和HTML代碼的分離問題
- 4.4.5、PHP項目開發中的程序邏輯結構
- 5、特定環境下PHP編碼特殊規范
- 5.1、變量定義
- 5.2、引用的使用
- 5.3、變量的輸入輸出