PHPDocumentのコードコメント仕様の概要

PHPDocument コードのコメント仕様

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

2． PHP仕様コメントの書き方

すべてのドキュメント タグは、各行の * の後の @ で始まります。 @マークが段落の途中にある場合、通常の内容として扱われ無視されます。

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

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

である必要があります。

/**
* XXXXXXX
*/

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

で記述する必要があります。

phpdoc で認識できるキーワード:

を含める 必須
include_once
require_once
定義
関数
グローバル
クラス

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 classes(如果是父类 就添加)
*/
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;
}
}