SORU
14 Ocak 2010, PERŞEMBE


PHPDoc: @return void gerekli?

Gerçekten gerekli böyle bir şey

/**
 * ...
 * 
 * @return void
 */

Dönüş değeri olmayan, tamamen birkaç yöntem var, ve gerçekten gereksiz yorum böyle bir şey koymak gibi görünüyor. Bırak artık şunu kabul fena olur?

CEVAP
14 Ocak 2010, PERŞEMBE


Eğer belgeler için net bir şey yaparsa, o zaman bırakın, ama kesinlikle gerekli değil. Tamamen öznel bir karar.

Şahsen, bunu duymamış olayım.

EDİT
Yanıldığımı kabul ediyorum. Biraz googling sonra, wikipedia page diyor ki:

@[type] Bu tag geri dönünkullanılmamalıdırkurucular ya da metotlar void dönüş türü ile tanımlanır.

Phpdoc.org web sitesi diyor ki:

@veri türü açıklama döndürür
@datatype1|datatype2 açıklama döndürür

@İade etiketi işlevler veya yöntemler dönüş değeri belgelemek için kullanılır. @döndürür. @için bir diğer ad diğer otomatik documentors etiket formatları desteği geri dönün

Veri türü, geçerli PHP bir tür olmalıdır(int, string, bool, vb.), nesne türü için bir sınıf adı verilen, ya da sadece "". karışık Eğer açıkça birden çok olası dönüş türleri göstermek istiyorsanız, onları boru ile sınırlandırılmış boşluksuz listesi ("@return int|string"). ör: Eğer bir sınıf adı @iade etiketi veri türü olarak kullanılır, phpDocumentor otomatik olarak bu sınıfı belgelerine bir bağlantı oluşturur. Eğer bir fonksiyon birden fazla Olası değeri döndürür buna ek olarak, onlara | karakteri ile ayırın ve phpDocumentor dönüş değeri herhangi bir sınıf adlarını ayrıştırmak. phpDocumentor isteğe bağlı açıklama değiştirilmemiş görüntüler.

Çoook..., boşluk bırakın derim buna dayanarak. Standart olmayan, en az.

Bunu Paylaş:
  • Google+
  • E-Posta
Etiketler:

YORUMLAR

SPONSOR VİDEO

Rastgele Yazarlar

  • DudeFromUkraine

    DudeFromUkra

    7 Ocak 2008
  • HowtoDrawAndPaint

    HowtoDrawAnd

    24 EKİM 2010