25

PHP アプリケーションでいくつかの連想配列を使用しており、PHP ドキュメンターを使用してソースにコメントを付けています。配列内の配列にコメントを指定したことは一度もありませんでしたが、今はそれを行う必要があり、その方法がわかりません。

$array = array('id' => 'test', 'class' => 'tester', 'options' => array('option1' => 1, 'option2' => 2))

@varこの配列に正しい方法でコメントを付けるにはどうすればよい@paramですか? 私はこのようにこれを行うことができますが、これが正しいかどうかはわかりません:

@param string $array['id']
@param string $array['class']
@param int $array['options']['option1']

しかし、@var部品に対してこれを行う方法は?

4

3 に答える 3

33

各キーを文書化することはできませんが、phpDocumentorにそれがどのタイプであるかを伝えることはできます。

あなたはこのようなことをすることができます：

/**
 * Form the array like this:
 * <code>
 * $array = array(
 *   'id'      => 'foo',          // the id
 *   'class'   => 'myClass',     // the class
 * );
 * 
 * </code>
 *
 * @var array[string]string 
 */
$array;
于 2010-04-27T20:57:44.043 に答える
9

現時点では包括的ではありませんが、いくつかのヒントについてはWordPress Inline Documentation Referenceを参照してください。

コンテキストに適した @param または @var または @property を使用します

これらのガイドラインに従って、連想配列を次のように文書化できます。

/**
 * @property array $my_array {
 *     An array of parameters that customize the way the parser works.
 *
 *     @type boolean $ignore_whitespace Whether to gobble up whitespace. Default true.
 *     @type string $error_level What the error reporting level is. Default 'none'.
 *                               Accepts 'none', 'low', 'high'.
 * }
 */
于 2013-10-29T20:19:41.587 に答える