8

だから、私が書いているphpコードを文書化している間、私は通常、@return string The json output私が実際にjsonを返す関数で言ったところを止めました。

だから、私は設定するのが正しいかどうか疑問に思っていました

*
* @return json
*/
public function test()
{
    $test = array('hola' => array('en' => 'hello', 'ro' => 'salut'));
    return json_encode($test);
}

それ以外の

*
* @return string
*/
public function test()
{
    $test = array('hola' => array('en' => 'hello', 'ro' => 'salut'));
    return json_encode($test);
}

関連する質問を検索し、マニュアルを見落としていましたが、私が見たものではなく、疑問を述べていました。

http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.return.pkg.html

アップデート

参考までに、私がこれらすべてを始めた場所を示します。私は数回見ましたが、次のとおりです。

*
* @return View
*/

それで、それは適切なリターンだと思いますか？

4

3 に答える 3

7

" json" は PHP のプリミティブ型ではなく、実際にはどの型でもありません。これらの型の内容が何を意味するかではなく、返された型を文書化する必要があります。jsonreturn "type" として指定すると、これは class のオブジェクトを意味します。これは、PHP では他の意味がないjsonためです。json

を返すものとしてのみ文書化できますstring。

于 2013-07-10T15:51:32.183 に答える
7

orangepill がコメントしたように、タイプを使用して説明stringを追加する必要JSONがあります。

@return string JSON

PHPDoc マニュアル

@return datatype description
@return datatype1|datatype2 description

データ型に関して、マニュアルには次のように記載されています

データ型は、有効な PHP 型 (int、string、bool など)、 返されるオブジェクトの型のクラス名、または単に "mixed" である必要があります。複数の可能な戻り値の型を明示的に表示したい場合は、それらをスペースなしでパイプ区切りでリストします (例: "@return int|string")。

于 2013-07-10T15:53:27.473 に答える
-1

json の戻り値の型を確認したいと思います。json を文字列の形式で返しているのは事実ですが、json はより具体的であり、何を期待するかを他の人に知らせます。

于 2013-07-10T15:52:21.807 に答える