2

関数が受信配列に特定のキー/インデックスを必要とする場合、コメント、特に PHPDoc でそれを表現する雄弁な方法はありますか?

例えば：

/**
 * Just an example function
 * @param array $arr My Example Array
 */

public function myFunction( $arr ){
    if(!array_key_exists('mykey', $arr)){
         echo 'Damnit, we needed an array that had mykey as an index!';
    }
}
4

3 に答える 3

1

このようなキーのリストを記述して@paramの説明に配置するか、メソッドのdocblockの長い説明に配置することができます。phpDocumentorがここのドキュメントで実際に実行できる「自動化された」または「厳密な」ものは何もありません。たとえば、他のドキュメント化された要素へのリンクなどです。

于 2012-08-23T15:55:28.410 に答える
0

いいえ、ありません。コメントセクションに入れるのがベストです。

于 2012-08-21T14:45:33.963 に答える
0

いいえ、特定の変数が必要な場合は、それを別のパラメーターにします。その場合、パラメータが空の場合、エラーがスローされます。

PHPでは配列値のデータ型を指定することはできません。したがって、PHPDocを介してそれを文書化する必要はありません。

于 2012-08-21T14:44:46.227 に答える