PHPDocumentコードコメントの標準的な書き方まとめ

/**
* ファイル名(sample2.php)
* by bbs.it-home.org
* 機能説明(省略)
* @packagesample2
*/
/**
* 同梱ファイル
*/
include_once 'sample3.php';< ;/p>
/**
* グローバル変数を宣言します
* @global integer $GLOBALS['_myvar']
* @name $_myvar
*/
$GLOBALS['_myvar'] = 6;
/**
* グローバル定数を宣言する
*/
define(' NUM', 6);
/**
* クラス名
*
* クラス関数の説明
*
* @package Sample2
* @subpackage クラス (親クラスの場合は追加)
*/
class myclass {
/**
* 通常の変数を宣言します
*
* @accessprivate
* @var integer|string
*/
var $firstvar = 6;
/**
* コンストラクター {@link $firstvar} を作成します
*/
function myclass() {
$this->firstvar = 7;
}
/ **
* 関数の定義
*
* 関数の説明
*
* @global string $_myvar
* @staticvar integer $staticvar
* @param string $param1
* @param string $param2
* @return integer|string
*/
function firstFunc($param1, $param2 = 'optional') {
static $staticvar = 7;
global $_myvar;
return $staticvar;
}
}
?>