2012-09-09 4 views
5

Lorsque vous utilisez la génération automatique de docblock php dans PhpStorm, j'ai fini avec l'annotation @static sur une méthode statique:À quoi servent les balises docblock php redondantes comme @static?

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

Est-il utile pour ces balises si elles peuvent être déduites à partir du code? J'essaie de décider si je devrais le quitter ou l'enlever (et le faire partout pour que ce soit cohérent).

Répondre

6

Ces balises ont été introduites pour le code PHP 4 qui ne permettait pas l'utilisation de tels mots-clés dans le code. Avec PHP 5, le code est auto-documenté, donc ces balises sont en effet redondantes; Je ne vois aucune raison de les garder. En fait, si vous générez de la documentation pour vos fichiers source PHP 5, phpDocumentor devrait être capable de déterminer qu'il s'agit de méthodes statiques. Ceci est mentionné dans le phpDocumentor docs:

Tout en utilisant la statique mot-clé dans votre code est suffisant pour PhpDocumentor de reconnaître sur les variables PHP5 et des méthodes statiques et PhpDocumentor va les marquer comme statique.

+1

Oh oui je ne pensais pas à PHP4, maintenant ça a du sens;) –