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) {
    // …在這裡執行…
  }
}

發佈留言