2012-05-23 2 views
2

Comment puis-je exécuter PHPDoc pour obtenir une liste d'erreurs sans générer la documentation complète?Utilisez PHPDoc pour trouver les erreurs seulement

J'essaye d'écrire un plugin pour mon IDE qui valide un fichier basé sur l'erreur générée par PHPDoc. Cependant, je n'en ai pas besoin pour passer la peine de produire de la documentation.

Je n'ai pas trouvé d'option dans phpdoc pour cela. Sinon, je pourrais utiliser PHPCodeSniffer pour renifler nos violations. Les règles de phpdoc sont-elles disponibles sous forme de sniffer?

erreurs Exemple (je sais que certains d'entre eux sont déjà disponibles en renifle mais je les préfère dans un endroit):

  • Aucune description courte pour la classe my_class
  • Argument entrée $ est absent de la docblock de myMethod()
+0

vous pouvez exécuter php -l fichier.php pour trouver des erreurs aussi bien (minuscule L) – ContextSwitch

+0

@ContextSwitch Je ne cherche pas à vérifier ma source. Je suis à la recherche d'erreurs soulevées par PHPDoc quand il génère de la documentation. Des choses comme "Vous avez manqué un param ici", pas "Erreur de syntaxe: Unexpected $ end' –

+2

Je ne connais aucun moyen pour que phpDocumentor fasse cela. Il accumule cette liste d'erreurs lors de l'analyse du code pour la génération de documents. Vous pourriez envisager de soumettre un problème Github pour demander cette fonctionnalité en tant que nouvelle fonctionnalité, car il pourrait très bien être facile à mettre en œuvre par @mvriel. – ashnazg

Répondre

2

According to phpdoc.org, vous pouvez générer une liste d'erreurs avec la commande suivante:

$ phpdoc -d [SOURCE] -t [TARGET] --template checkstyle 

That link propose également plusieurs méthodes alternatives pour ce faire.

Questions connexes