PHP开发编码规范

更新时间2022-04-15

PHP类的注释

前言

PHP程序头注释块

每个程序头部必须有统一的注释块，规则如下：
a．必须包含本程序的描述；
b．必须包含作者；
c．必须包含书写日期；
d．必须包含版本信息；
e．必须包含项目名称；
f．必须包含文件的名称；
g．重要的使用说明，如类的调用方法、注意事项等；
参考例子如下：

<?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 $

PHP类的注释

相关视频

免费