PHP7を使用する場合、PHPDocでメソッドを文書化する必要がありますか？

Question

PHP7では、メソッドが与えられたパラメータの型と結果の型を設定するときに、それらをPHPDocで再度ドキュメント化する必要がありますか？

function foo(string $text): bool 
{ 
    return true; 
} 

は

/** 
* @param string $text 
* @return bool 
*/ 
function foo($text) { 
    return true; 
} 

と同等であるため、これらの情報を複製することが必要ですか？

/** 
* @param string $text 
* @return bool 
*/ 
function foo(string $text): bool 
{ 
    return true; 
} 

編集：私は自分のコードのドキュメントを生成したPHPDocを使用しませんが、PHPStormの助けを借りて、私と私の同僚のための方法で一貫性を維持します。

Answer 1

のdocblockがコーダ機能は、ありません、それはそれは単なるコメントであるとして、それは、PHPパーサーによって無視されますかを説明するために使用することができるものですより多くの情報を見つけることができます誰か（またはあなた）がコードを読んだときに、その関数が何をしているのかが分かりやすいため、すべての関数とメソッドの上にdocblockを置くことをお勧めします。

A IDEは通常、オートコンプリートのためにのdocblockを使ってブロックをコード

と一致しない場合、docblockには、しかし、しかし

function foo(string $text): bool 
{ 
    return true; 
} 

と等価ではありませんstringと:boolによって上書きされます

/** 
* @param string $text 
* @return bool 
*/ 
function foo($text) { 
    return true; 
} 

最初の例で:boolが強制そのfoo()trueまたはfalseのいずれかを返します。それ以外の場合、PHPはその型への戻り値のキャストを試みるか、致命的なエラーをスローします。 $textの場合はタイプヒントstringと同じです。最初のパラメータは、単に期待リターンがtrueかのどちらかであると言う、そうでない場合、PHPは文字列または致命的なエラーにそれをキャストしようとし

をスローされます@return boolと@param stringは全く何も強制しない、文字列型の値でなければなりません。

function foo(string $a) :bool 
{ 
    var_dump($a); // string '10' 
    return "string"; 
} 

var_dump(foo(10)); // bool true 

が問題なし、PHPは文字列に10をキャストすることができますし、"string"がtrue があります：false

は、次の例を見てみましょう

注意を（おそらくPDOオブジェクトに何かをしようとしているので、おそらく、さらに上の他の問題に実行している）最後の1つの作業を行うのdocblockを使用して、次の

function foo(PDO $a) :bool 
{ 
    var_dump($a); 
    return "string"; 
} 

var_dump(foo(10)); // fatal error, 10 is not PDO and can not be cast to PDO 

かかわらの問題点：PHPはありませんまだブロック型で指定しなければならない混合型の型ヒント（つまり文字列配列）をサポートしていません

Answer 2

PHP 7では同じであるため、必ずしも必要ではありません。もしあなたが両方を持っていれば、後にあなたがもう一方を変えずに一方を変えれば、それは同期していないかもしれません。ここで

あなたは https://wiki.php.net/rfc/scalar_type_hints_v5