PHPDoc: Gerekli dönüş boşluğa @?

3 Cevap php

Gerçekten gerekli böyle bir şey yapmak mı:

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

Ben bir dönüş değeri yok epeyce yöntemleri var, ve bu açıklamada böyle bir şey koymak için gerçekten çok gereksiz görünüyor. Onu dışarı çıkmak için kötü formu olarak kabul edilebilir misiniz?

3 Cevap

Bunun açıkça belgeler için yaparsa, o zaman bırakın, ama kesinlikle gerekli değildir. Bu tamamen subjektif bir karar.

Şahsen, ben onu dışarı bırakacaktı.

EDIT
I stand corrected. After a liitle googleing, the wikipedia page says:

@ Void dönüş türü ile tanımlanan kurucular veya yöntemleri Bu etiket should not be used [tipi açıklama] dönmek.

Phpdoc.org web sitesi diyor ki:

@return datatype description
@return datatype1|datatype2 description

@ Return etiketi işlevler veya yöntemler dönüş değeri belgelemek için kullanılır. @ Döner diğer otomatik documentors etiketinin formatlarını destekleyen @ dönüş için bir takma ad

The datatype should be a valid PHP type (int, string, bool, vs), nesne türü için bir sınıf adı iade veya basitçe "karışık". ("| Dize return int @" gibi) açıkça birden çok olası dönüş türleri göstermek istiyorsanız, onlara boru ayrılmış boşluksuz liste. Bir sınıf adı @ dönüş etiketi veri türü olarak kullanılması durumunda, phpDocumentor otomatik olarak o sınıfın belgelerine bir bağlantı oluşturur. Buna ek olarak, bir fonksiyon birden fazla olası değerleri döndürür, kullanarak onları ayırmak | karakterini ve phpDocumentor dönüş değeri herhangi bir sınıf isimlerini ayrıştırmak olacaktır. phpDocumentor bağlı bir açıklama değiştirilmemiş gösterecektir.

Sooo ..... Buna dayanarak, ben boşluğu dışarı bırakın söyleyebilirim. Bu en azından, standart dışı bulunuyor.

PhpDocumentor göre, @ return void geçerlidir:

http://www.phpdoc.org/docs/latest/for-users/phpdoc/types.html

... this type is commonly only used when defining the return type of a method or function. The basic definition is that the element indicated with this type does not contain a value and the user should not rely on any retrieved value.

Örneğin:

 /**
  * @return void
  */
 function outputHello()
 {
     echo 'Hello world';
 }

In the example above no return statement is specified and thus is the return value not determined.

@return void PHP neden geçersiz olduğunu sebebi, her işlevi her zaman verir, çünkü NULL. Kolayca kendiniz test edebilirsiniz.

function do_i_return_something() {}

var_dump(do_i_return_something());

Eğer kodu çalıştırırsanız var_dump() yazdıracak NULL.

Eğer belge istiyorsanız fonksiyonları @return null gitmek için vücutta geri dönüşü yoktur değerini döndürür.