PHPドキュメントで使用される擬似タイプと変数

965 ワード

クラスやメソッド(関数)の注釈をよく書くとき、以下のコードブロックの括弧で示すように、@paramまたは@returnタイプの説明があります.
/**
 * @desc        
 * 
 * @param {Array} params
 * @return {Object}
 */
function check(){
    // TO DO
}

コードブロックの括弧のarray|objectは実は偽のタイプです;擬似タイプ(pseudo-types)は、PHPドキュメントでパラメータが使用可能であることを示すタイプと値です.PHP言語の原生タイプではないことに注意してください.したがって、カスタム関数のタイプコンストレイント(typehint)に擬似タイプを使用することはできません.
mixed
mixedは、1つのパラメータが複数の異なる(必ずしもすべてではない)タイプを受け入れることができることを示す.
例えばgettype()はすべてのPHPタイプを受け入れることができ、str_replace()は文字列と配列を受け入れることができます.
number
numberは、1つのパラメータがintegerまたはfloatであってもよいことを示す.
callback
この文書では、PHP 5.4でcallableタイプを導入する前にcallbackダミータイプを使用しています.両者の意味はまったく同じだ.
array|object
array|objectは、パラメータがarrayであってもobjectであってもよいことを意味する.
void
voidが戻りタイプであることは,関数の戻り値が不要であることを意味する.voidがパラメータリストとして機能することは、関数がパラメータを受け入れないことを意味する.
もちろんこれらのタイプに加えて、Boolean、Integer、Float、Stringもよく使われています.
これらのタイプを知って、今コメントを書くとこれらのタイプの説明が漏れないでしょう.phpからnet