PHP 编码规范(28)

10 代码范例

/*
　* @(#)Cngift.php 1.82 03/06/25
　*
　* 开花石头编写的示例文档
　* 将对编码规范做简单的示范
　*
　*/

require( “db.php” );

/**
　* 示范用类
　*
　* @version 1.82 03.06.25
　* @author 开花石头
　*/
class Blah extends SomeClass {
　　/* 这个类运行时的注释写在这里 */

　　/** 关于变量的注释写在这里 */
　　static int $classVar1;

　　/**
　　　* 对变量编写的多行注释写在这里
　　　*/
　　static string classVar2;

　　/** 变量的文档注释 */
　　int instanceVar1;

　　/** 变量的文档注释 */
　　int[] instanceVar3;

　　/**
　　　* 构造函数的注释
　　　*/
　　function Blah() {
　　　　// ...在这里执行...
　　}

　　/**
　　　* ...函数的文档注释...
　　　*/
　　function doSomething() {
　　　　// ...在这里执行...
　　}

　　/**
　　　* ...方法的注释文档..
　　　* 多行注释
　　　*/
　　public void doSomethingElse(Object someParam) {
　　　　// ...在这里执行...
　　}
}