2014-11-04 13 views
6

Bu gerçekten yeni bir soru.PHPDoc'taki @author etiketi ne zaman güncellenir?

PHP ile becerilerimi geliştirmeye çalışıyorum, bu yüzden bazı kütüphanelerin kodunu okuyorum. @author etiketini içerir: Birçok klasörlenebilmesini başlıkları (?

/** 
* @param $config 
* @return bool 
* @author developer1 
*/ 

bu hakkın adıdır bu demek) fark ettim.

Geliştiricinin 2 geliştirici1 işlevinde büyük değişiklikler yaptığını ve github'a bağlı olduğunu varsayalım. Developer2 @author etiketini güncellemeli mi?

Genel uygulama nedir?

+0

, muhtemelen hala muhafaza ediyor bir dokümantasyon sistemi kullanmalıdır 2000'den beri yayınlanacak. Bunu bir PHP sorusu olarak görmüyorum, gerçekten - lisans, ekibiniz ve orijinal yazarla belirleyeceğiniz bir şey. – ceejayoz

+0

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

+0

Yazar, genellikle yalnızca orijinal olarak dosyayı oluşturan/kavramsallaştıran kişi veya kişilerdir. – Flosculus

cevap

4

phpDocumentor 2 desteği çoklu @author etiketler: - PHPDoc bir olmamıştır PHP becerilerini geliştirmek için arıyorsanız

/** 
* Class User 
* @author Styx 
* @author second author 
* @package Application\Model 
*/ 
class User 
{ 
} 

http://www.phpdoc.org/docs/latest/references/phpdoc/tags/author.html

+0

Teşekkürler! 1 şey hakkında kafam karıştı. @ceejayoz, PHPdoc'un artık sürdürülmediğini söyledi. Bu phpDocumentor 2 onun halefi mi? – wwr

+2

@wwr phpDocumentor ve Doxygen popüler değiştirmelerdir. – ceejayoz

İlgili konular