gZt9rU  <a href="http://wcfcqatexqer.com/">wcfcqatexqer</a>, [url=http://chzbezsnuehi.com/]chzbezsnuehi[/url], [link=http://ylntbgouybln.com/]ylntbgouybln[/link], http://cuomxvtlvkpa.com/
[[http://www.phpdoc.org/]]

#contents

*インストール [#r0a9d9e5]

PHP5には1.3.0RC3から対応

 # pear install http://pear.php.net/get/PhpDocumentor-1.3.0RC5.tgz
 # pear install --alldeps XML_Beautifier

*ドキュメント作成 [#lafa6605]

-- [-t] ドキュメントを出力するディレクトリ
-- [-d] PHPソースがあるディレクトリ 複数の場合はカンマ区切り
-- [-o] 出力用テンプレート [出力形式:コンバータ:テンプレートディレクトリ名]

 # phpdoc -t ./php_document/ -d /php_source/ -o HTML:Smarty:PHP

*主要タグ説明 [#a36c6fa9]

**@access [#l7bffe3f]
public, privateいずれか

**@author [#qb46f90e]

 /**
  * @author 作者
  */

**@copyright [#ue9f5a48]

 /**
  * @copyright Copyright &copy; 2006 yassu
  */

**@global [#hd6e1aab]
グローバル変数について記述

 /**
  * @global test $GLOBALS['bar']
  * @name $bar
  */
 $GLOBALS['bar'] = new test

**@link [#d451414e]
ハイパーリンクを記述

 /**
  * @link http://yassu.jp/
  */

**@package [#c016ae33]
パッケージ名

**@param [#m74107a3]
[型]、[名前]、[説明]を記述

 /**
  * @param int $age 年齢
  * @return boolean 成功したら TRUE を返す
  */

**@return [#x193802a]
[型]、[説明]を記述

**@see [#g7fec43a]
関連する変数,関数を記述すると自動的にリンクしてくれる

 /**
   * @see SelectAge(), UpdateAge()
   */

**@var [#hd97c845]
変数の型を記述

**@version [#za57b3e7]
バージョン情報。CVS の $Revision$ タグ等

 /**
  * @version $Revision: 1.00 $
  */

*実践 [#ef310f57]

**クラス [#c8d68ce1]
 /**
  * 説明
  *
  * @author 作者
  * @version $Revision: 1.00 $
  * @package Hoge
  * @see http://yassu.jp/
  */
 class Hoge {
 
 }

**変数 [#mc98809a]
 /**
  * 説明
  *
  * @var int
  * @see SelectAge(), UpdateAge()
  */
 var $age = 34;

**関数 [#o4d5bc3d]
 /**
  * 説明
  *
  * 詳細説明
  *
  * @access public
  * @see SelectAge()
  * @param int $age 年齢
  * @return boolean 成功したら TRUE を返す
  */
 function SelectAge($age)
 {
      return TRUE;
 }

*型 [#geff8381]

**boolean [#e6e518e9]
論理値 TRUE or FALSE

**integer [#xeec9311]
整数

**float [#tc85af95]
浮動小数点数 double

**string [#web0dbad]
文字列

**array [#a7ba07fe]
配列
 
**object [#d3f454e1]
オブジェクト

**resource [#eaad183f]
リソース~
[[@see:http://jp.php.net/manual/ja/resource.php]]

**NULL [#v1726fdc]

**mixed [#q8777b5b]
引数に多様な型を使うことができることを示す

**number [#fc27028c]
integer or float

**callback [#t6c8fb40]
[[@see:http://jp.php.net/manual/ja/language.pseudo-types.php#language.types.callback]]

#exlink


トップ   編集 差分 バックアップ 添付 複製 名前変更 リロード   新規 一覧 検索 最終更新   ヘルプ   最終更新のRSS