php - PHPで許容される配列パラメータ値を文書化するにはどうすればよいですか

Question

多くの場合、コンストラクターのパラメーターとして配列を渡します。許容値を文書化するにはどうすればよいですか? いくつかのスタイルを試してみましたが、phpdoc では少し混乱しているように見えます。

Answer 1

ハッシュ化された配列を文書化するための「公式の」phpdoc の方法は実際にはありませんが、ここに 1 つの方法があります。

/**
 * @param array $options hash of standard options for this class:
 *    int id the id of whatever object
 *    string name name of whoever it is
 *    array sub_option hash of sub options:
 *        int num number description for this index
 *    bool is_good should we do this or not?
 */
 function __construct( $options ){
 }