2012-09-09 5 views
5

Quando si utilizza la generazione automatica docblock php in PhpStorm, ho finito con il @static annotazioni su un metodo statico:Qual è il punto dei tag ridondanti di docblock come @static?

/** 
* Reset the singleton instance, for the tests only 
* @static 
*/ 
public static function reset() { 
    self::$singletonInstance = null; 
} 

C'è qualche uso per questi tag se possono essere dedotte dal codice? Sto cercando di decidere se lasciarlo o rimuoverlo (e farlo ovunque, quindi è coerente).

risposta

6

Questi tag sono stati introdotti per il codice legacy di PHP 4 che non consentiva l'uso di tali parole chiave nel codice. Con PHP 5, il codice è effettivamente auto-documentante, quindi questi tag sono effettivamente ridondanti; Non vedo alcun motivo per tenerli in giro.

Infatti, se si genera documentazione per i file sorgente di PHP 5, phpDocumentor dovrebbe essere ancora in grado di determinare che si tratta di metodi statici. Questo è menzionato nel phpDocumentor docs:

Proprio utilizzando la parola chiave static nel codice è sufficiente per phpDocumentor su PHP5 a riconoscere variabili e metodi statici, e phpDocumentor segnerà loro come statica.

+1

Oh sì, non ho pensato a PHP4, ora ha senso;) –