2014-11-04 19 views
6

Questa è davvero una domanda da principianti.quando aggiornare il tag @author in PHPdoc?

Sto cercando di migliorare le mie competenze con PHP, quindi sto leggendo il codice di alcune librerie. Ho notato che molti intestazioni PHPDoc (è questo il nome giusto voglio dire questo:?

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

) contengono il tag @author.

Diciamo che sviluppatore2 apporta enormi modifiche alla funzione dello sviluppatore1 e quindi si impegna a github. Lo sviluppatore2 dovrebbe aggiornare il tag @author?

Qual è la pratica comune?

+0

Se stai cercando di migliorare le capacità di PHP, probabilmente si dovrebbe utilizzare un sistema di documentazione che è ancora mantenuto - PHPDoc non ha avuto un rilascio dal 2000. Non vedo questa domanda come una domanda PHP, davvero - è qualcosa che dovresti determinare con la licenza, il tuo team e l'autore originale. – ceejayoz

+0

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

+0

L'autore è in genere solo la persona o le persone che hanno originariamente creato/concettualizzato il file. – Flosculus

risposta

4

phpDocumentor 2 di supporto più tag @Author:

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

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

+0

grazie! Sono confuso su 1 cosa. @ceejayoz ha detto che PHPdoc non è più mantenuto. Questo phpDocumentor 2 è il suo successore? – wwr

+2

@wwr phpDocumentor e Doxygen sono sostituzioni popolari. – ceejayoz