Générateur de documentation PHP et Javascript

Question

Je suis en train de générer des documents API pour une application web interne qui subit une expansion. C'est un projet DHTML, avec un mix de quelques OO et surtout du PHP procédural, et du Javascript purement procédural. À l'heure actuelle, c'est à peu près tout documenté pour les générateurs de doc appropriés (phpdocumentor et jsdoc), mais les deux n'étaient jamais "connectés". Je pourrais passer par et ajouter des instructions de lien manuel aux blocs doc, mais la gestion de tous ces liens (comme "../jsdoc/filename.html#function) est une vraie douleur."

Toutes les suggestions pour les générateurs de documentation qui traitent les deux PHP et JavaScript, et permettent quelque chose comme @see NomFonction entre les langues?

Si le pire se produit, je peux bidouiller un script pour réécrire des URLs LINK à partir d'une syntaxe magique (ie js: et php :), mais je ' d vraiment plutôt avoir quelque chose qui permettra une vue arborescente unifiée de tout.

Merci, Jason

Answer 1

Après avoir regardé un certain nombre d'options, j'ai écrit un script PHP qui analyse les fichiers JS, extrait les blocs doc et les définitions de fonctions, puis l'écrit dans un fichier que phpdoc peut traiter. Il suffit d'ajouter une ligne à phpDocumentor.ini pour analyser les fichiers .js.

Le billet de blog en parler est à: http://blog.jasonantman.com/2010/08/documentation-generation-for-web-apps-php-and-javascript/ Et le script est à l'adresse: http://svn.jasonantman.com/misc-scripts/