PHPDocumentのコードコメント仕様まとめ_PHPチュートリアル

1. phpDocumentor をインストールします (コマンドラインでのインストールは推奨されません)
最新バージョンの PhpDoc を http://manual.phpdoc.org/ からダウンロードします
ブラウザーからアクセスできるように、Web サーバーのディレクトリに置きます
「ファイル」ボタンをクリックし、処理する php ファイルまたはフォルダーを選択します。このインターフェースで無視するファイルを指定することで、特定のファイルの処理を無視することもできます。
次に、出力ボタンをクリックして、生成されたドキュメントの保存パスと形式を選択します。
最後に作成をクリックすると、phpdocumentor が自動的にドキュメントの生成を開始します。

2. PHP 仕様コメントの書き方
すべてのドキュメントタグは、各行の * の後に @ で始まります。 @マークが段落の途中にある場合、通常の内容として扱われ無視されます。 @access このタグは、キーワードのアクセス許可を示すために使用されます: private、public、または protected 使用範囲: class、function、var、define、module
@author 作成者を指定します
@copyright 著作権情報を指定します
@const 範囲use:define PHPで定義された定数を指定するために使用します
@final 使用範囲:class、function、var キーワードがfinalクラス、メソッド、属性であることを示し、派生と変更を禁止します。
@global は、この関数で参照されるグローバル変数を指定します。
@name は、キーワードのエイリアスを指定します。
@package は、1 つまたは複数のキーワードを論理的にグループ化するために使用されます。
@abstrcut は、現在のクラスが抽象クラスであることを示します。
@param は、関数のパラメータを示します。
@return は、メソッドまたは関数の戻り値を示します。
@static は、キーワードが静的であることを示します。
@var は変数の型を示します
@version はバージョン情報を示します
@todo は改善すべき領域または実装されていない領域を示します
@link リンクを通じてドキュメント内の任意のキーワードをポイントできます
@ingore は、ドキュメント内の指定されたキーを無視するために使用されますドキュメント Word

一部のコメント仕様
a. コメントは /**
* XXXXXXX
*/

b. グローバル変数を参照する関数の場合は、glboal タグを使用する必要があります。
c. 変数の場合、その型 (int、string、bool...) は var
d でマークする必要があります。関数は、2 回出現する変数の場合は、パラメータと戻り値のマーカー
e を使用する必要があります。他の関数またはクラスが呼び出される場合、ドキュメントを読みやすくするために、リンクまたは他のタグを使用して対応する部分にリンクする必要があります。
g. コードの読みやすさを向上させるために、必要に応じてドキュメント以外のコメント (PHPDOC が認識できないキーワードの前のコメント) を使用します。
h. 可能な限り文章ではなくフレーズを使用して、説明内容を簡潔かつ要点に保ちます。
i. グローバル変数、静的変数、定数は対応するタグで記述する必要があります

phpdocで認識できるキーワード:
IncludeRequireinclude_once
require_once
define
function
global
class

3. 標準の注釈付き PHP コード:

/*** ファイル名(sample2.php)
*
* 機能説明(省略)
*
* @author steve
* @version 1.0
* @package sample2
*/
/**
* 同梱ファイル
*/
include_once 'sample3.php';
/**
* グローバル変数を宣言します
* @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 = 'オプション') {
static $staticvar = 7;
global $_myvar;
return $staticvar;
}
}
?>

http://www.bkjia.com/PHPjc/327853.html

www.bkjia.comtru​​ehttp://www.bkjia.com/PHPjc/327853.html技術記事 1. phpDocumentor をインストールします (コマンド ラインでのインストールは推奨されません)。http://manual.phpdoc.org/ から PhpDoc の最新バージョンをダウンロードし、ブラウザからアクセスできるように Web サーバー ディレクトリに置き、[f] をクリックします。 ...