本地數組上的 phpdocs

Question

我的同事拒絕了我的代碼審查，因為函數中的本地數組（底部示例中的$params ）上有一個不必要的 phpdoc。 看例子：

/**
 * comment...
 *
 * @return int
 */
public function testFunction()
{
    /** @var string[] $params */
    $params = ['string1', 'string2'];

    etc...

    return 0;
}

有人可以向我解釋為什么不需要在本地數組上定義 phpdocs 嗎？ 我從我的同事那里得到了一個解釋，我們不需要在本地數組上編寫 phpdoc。 我們正在使用 PhpStorm 和 Doctrine。

謝謝你的時間。

Answer 1

當數組是參數或返回值時，為數組編寫類似string[]的 phpdoc 很有用，因此您可以指定數組應包含的值類型。 但在這種情況下，它是一個定義在那里的字符串文字數組。 phpdoc 並沒有告訴你任何你看不到的東西。

從技術上講，@ @var旨在記錄類屬性，但在某些情況下，它在函數內部很有用，可在 IDE 無法確定變量類型時提供幫助。 不過，這也不是真正需要的。

我不確定這是否正是你的同事認為沒有必要的原因，但我沒有看到其他合乎邏輯的解釋。