2

初日、私はphpDocumentorを使用し、これまでのところ非常にうまくいっていますが、マニュアルでキャッチできなかった質問があります... グローバル変数のドキュメント。

次の場合、このコードをどのように文書化しますか。

  1. $someGlobalVar は、クラスの PHP ファイルでdecalren ではありません(undelared にすることもできます)。
  2. $someGlobalVar は次のように宣言されます: $someGlobalVar = array(); (phpDocumentor マニュアルのようにスーパーグローバル配列を使用しないでください)。

PHP コード:

class myCustomClass
{
    private $someProperty;

    //I want to document the use of global var in this method
    public function getSomeProperty()
    {
        global $someGlobalVar;

        if (isset($someGlobalVar))
        {
            //...
        }
        else
        {
            //...
        }
    }
}

編集:マニュアルに示されているようにこれらのグローバルを文書化したいのですが、 @global および @name タグをどこに/どのように配置するかわかりません。

編集 2: getSomeProperty の宣言の直前に、次のスニペットを使用することになりました。

/**
 * Get some property based on the $someGlobalVar global.
 * @global array $someGlobalVar User defined array that bla bla bla.
 * @return mixed Return a result bla bla bla.
 */

NetBeans IDEがソース コードにインライン ヘルプを表示するように、phpDocumentor 構文を使用します。NetBeans ではすべてが正しいように見えますが、それが正しい方法かどうかはわかりません...

誰でも大丈夫だと確認できますか？

4

2 に答える 2

1

$someGlobalVar はユーザー定義であるため、いくつかの調査の結果、 @usesがこれを文書化するのに最も適した方法であると思います。

@uses $someGlobalVar User defined array that bla bla bla.

ドキュメントから：

@uses タグは、任意の要素 (グローバル変数、インクルード、ページ、クラス、関数、定義、メソッド、変数) を文書化するために使用できます。

于 2010-02-03T13:58:11.827 に答える
1

変数が定義されている場所を文書化します。たとえば、

/**
 * My var
 * @var array
 */
$someGlobalVar = array();

API とその機能を文書化するので、クラス メソッド内で文書化する必要はありません。

とにかく私の意見。

于 2010-01-29T21:28:29.237 に答える