Recommandations à d’autres personnes envisageant phpDocumentor:
J'ai eu de l'expérience avec Swagger et PHPDoc. Swagger est complexe et prend du temps pour rédiger des documents. PHPDoc offre une seule manière simple d'écrire des documents au milieu du code. La seule fonctionnalité manquante avec PHPDoc est le manque de support pour les tableaux typés imbriqués ainsi que les tableaux clé-valeur. Avis collecté par et hébergé sur G2.com.
Quels sont les problèmes que phpDocumentor résout, et en quoi cela vous est-il bénéfique?
Les documenteurs de code source résolvent deux problèmes principaux : "Livraison de code source" et "Référencement d'API". Les deux outils de documentation bien connus pour PHP sont PHPDoc et Swagger. Swagger fournit une solution plus complexe pour documenter le code PHP. Vous pouvez soit intégrer la syntaxe au milieu du code, soit simplement créer des fichiers séparés pour la documentation. Les classes doivent être mappées indépendamment, ce qui rend la rédaction d'un document plus chronophage. Même la syntaxe intégrée est difficile à écrire. D'autre part, la seule chose que vous devez faire avec PHPDoc est d'écrire votre document au-dessus de vos définitions. La syntaxe est claire, a un support natif par les IDE populaires, y compris PHPStorm, Netbeans, etc., et dans l'ensemble, tout se déplace très facilement. Avis collecté par et hébergé sur G2.com.