PHP開(kāi)發(fā)編碼規(guī)范
/ PHP程序頭注釋塊
PHP程序頭注釋塊
PHP程序頭注釋塊
每個(gè)程序頭部必須有統(tǒng)一的注釋塊，規(guī)則如下：
a． 必須包含本程序的描述；
b． 必須包含作者；
c． 必須包含書寫日期；
d． 必須包含版本信息；
e． 必須包含項(xiàng)目名稱；
f． 必須包含文件的名稱；
g． 重要的使用說(shuō)明，如類的調(diào)用方法、注意事項(xiàng)等；
參考例子如下：
<?php // // +---------------------------------------------------------+ // | 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 <ssb@fast.no> | // | Tomas V.V.Cox <cox@idecnet.com> | // | | // +---------------------------------------------------------+ // // $Id: Common.php,v 1.8.2.3 2001/11/13 01:26:48 ssb Exp $