Bir süredir bu konu hakkında araştırma yapıyorum ve doğru arama terimlerini kullanmıyorum veya bir şeyleri özlüyorum.phpdoc - bir yöntem için dönüş nesne değişkenlerini tanımlamak
Nesne tarafından döndürülen değişkenleri tanımlamak için PHPdoc kullanmanın mümkün olup olmadığını anlamaya çalışıyorum.
class SomeClass {
public function staffDetails($id){
$object = new stdClass();
$object->type = "person";
$object->name = "dave";
$object->age = "46";
return $object;
}
}
Şimdi, giriş parametrelerini tanımlamak için yeterli kolaydır:
Ben aşağıdaki sınıf olduğunu düşünelim./**
* Get Staff Member Details
*
* @param string $id staff id number
*
* @return object
*/
class SomeClass {
public function staffDetails($id){
$object = new stdClass();
$object->type = "person";
$object->name = "dave";
$object->age = "46";
return $object;
}
}
sorudur benzer bir şey, başka bir programcı bu sınıfı açıp elle ne görmek yöntem haline bakmak zorunda kalmaması söz konusu yöntem ile döndürülen nesnenin çıkış değişkenlerini tanımlamak için var dönüş nesnesi geri geliyor?
Neden sadece tip, isim ve yaş özelliklerine sahip bir StaffDetails sınıfını yok mu? Daha sonra stdClass için bir beton türü yapmak istemiyorsanız @param StaffDetails – Ken
'u kullanabilirsiniz. Ayrıca, '@return \ stdClass türünü, adını ve yaşını 'yazabilir veya Doc Block'un uzun açıklamasında açıklayabilirsiniz. En azından belgelendi o zaman. Bu, IDE'nizi özelliklerle sihirli bir şekilde bilmez. – Gordon
no - IDE'nin özellikleri bilmesini istemiyorum. Sadece güzel bir şekilde belgelenmelerini istiyorum. Aslında kullandığım nesne içinde yaklaşık 40 değişken var, bu yüzden giriş parametrelerinin göründüğü gibi bir tabloya güzelce yerleştirmenin bir yolu olup olmadığını bilmek istedim. Aksi takdirde uzun bir açıklama kullanarak sadece dağınık ve okumak zorlaşır. – someuser