質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

88.03%

連想配列を引数に用いた時のDocコメントの書き方

解決済

回答 1

投稿

  • 評価
  • クリップ 2
  • VIEW 6,834

score 609

次の様に引数に連想配列を用いた時のDocコメントはどの様に書くのが適切なのでしょうか?
/**
 * 関数の説明
 *
 * @param associative array 引数の名前 引数の説明
 * 引数の指定が無いので引数の名前が書けない…
 * 連想配列の中身の説明はどの様に書けば…
 */
function func() {
    // 初期値
    $initial_args = array(
        'abc' => null,
        'def' => false,
        'ghi' => array(
            'one' => 10,
            'two' => 'string'
        )
    );

    // 引数を取得
    $args = func_get_args();
    $args = $args[0];

    // 処理内容
}
  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 1

check解決した方法

+1

次の様な書き方に落ち着きました

参考: WordPress › PHP Documentation Standards « Make WordPress Core
/**
 * 概要
 *
 * 説明
 * 必須のパラメータ以外は省略可能
 *
 * @param array {
 *     以下の各要素を格納した連想配列(必須) Default 'abc', 'def', 'ghi'
 *
 *     @type string 'abc' 説明(必須) Default null.
 *     @type bool 'def' 説明 Default false.
 *     @type array 'ghi' {
 *         以下の各要素を格納した連想配列 Default 'one', 'two'
 *
 *         @type integer 'one' 説明 Default 10.
 *         @type string 'two' 説明 Default 'string'.
 *     }
 * @return データ型 戻り値 説明
 */

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 88.03%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る