Question

Quelqu'un utilise-t-il autre chose pour documenter son code PHP que PHPDoc? Existe-t-il des outils qui lisent la même syntaxe de documentation mais donnent des résultats plus riches?

Était-ce utile?

La solution

Je choisirai aussi le doxygen.

Voici plusieurs raisons:

  • compatible avec les balises phpdoc et autres tags populaires: il est interopérable
  • fonctionne avec différents langages de programmation: un meilleur investissement en temps
  • il existe des syntaxes alternatives: vous pouvez choisir le style de commentaire qui vous convient
  • très efficace avec le formating / tagging / metadata avancé
  • il existe une interface graphique qui n'est liée à aucun IDE et un plug-in eclipse également

Et toujours libre, multiplateforme et open source: -)

C’est facile à apprendre, mais plus difficile que phpdoc car beaucoup plus riche.

Autres conseils

Vous pouvez essayer DocBlox; qui est destiné à être une alternative à phpDocumentor mais avec un support pour des fonctionnalités supplémentaires, dont le support complet de PHP 5.3. Un avantage supplémentaire est qu’il est assez rapide et utilise relativement peu de mémoire.

Vous pouvez en savoir plus sur http://www.docblox-project.org ou voir une démonstration. sur http://demo.docblox-project.org/default

Une autre option que phpDocumentor est la la documentation Doxygen avec PHP .

Doxygen ( www.doxygen.org ).

ApiGen

http://apigen.org/

ApiGen prend en charge les espaces de noms PHP 5.3, les packages, les liens entre la documentation, les références croisées avec les classes standard PHP et la documentation générale, la création de code source en surbrillance et la prise en charge expérimentale des traits PHP 5.4.

DocBlox

http://www.docblox-project.org/

Générateur de documentation API compatible PHP 5.3 destiné aux projets de toutes tailles et à l’intégration continue.

capable d'analyser et de transformer complètement Zend Framework 2

J'utilise Doxygen aussi - vous vous habituez très vite aux différents mots clés - ils sont un peu comme les autres -expliquer. ;)

RubyDoc est bien aussi, j'aime particulièrement la mise en page des rdocs.

Doctrine utilise PHPDoctor, qui semble bien fonctionner avec la version 5.3 dans mes tests.

http://peej.github.com/phpdoctor/#download

Je ne l'ai pas utilisé avec PHP, mais doxygen prétend prendre en charge le langage.

Si vous avez besoin de documenter le code pour PHP 5.3+, par exemple. S'il utilise des espaces de noms, fork de PHPDoctor de Ted Kulp pourrait être votre réponse.

Licencié sous: CC-BY-SA avec attribution
Non affilié à StackOverflow
scroll top