PHPのドキュメント作成にPhpDocumentorを使ってみる コメントの書き方
- 2009.03.01 (日) 10:29
- PHP
- phpdocumentor
PhpDocumentorを使用する場合のコメントの書き方についてのまとめです。
PhpDocumentorの使い方については以前に書いた記事があるのでこちらを見てください。
自分が書くときの備忘録なので、詳しい内容が知りたい方はPhpDocumentorのドキュメントを見てください。
クラスを記述する時のコメント
1 2 3 4 5 6 7 8 9 10 11 12 13 |
/**
* DB管理ツールクラス
*
* 以下の機能を保持しているクラス
* テーブルの作成、データの登録、更新、削除、検索ができる。
* データのインポート、エクスポート機能
*
* @access public
* @author Masaru Hashizume
* @copyright Copyright (c) 2009, Masaru Hashizume
* @version 1.00
* @since 2009/02/21
*/
|
プロパティ／変数に記述する時のコメント
|
1 |
/** |
関数／メソッドに記述する時のコメント
1 2 3 4 5 6 7 8 |
/**
*
* NewEntryテーブルにデータを登録する
*
* @access public
* @param array 登録データ
* @return void
*/
|
コメントに使用する記述内容一覧
1 2 3 4 5 6 7 8 9 10 |
@abstract @final @access public @author Masaru Hashizume @copyright Copyright (c) 2002, Masaru Hashizume @param bool $baz @return mixed @version 1.00 @see function parent_method @since 2009/03/01 |
