Question

Connaissez-vous un outil pour créer facilement documentation pour le code JavaScript et PHP?

Quelque chose qui prend des commentaires dans un code similaire à celui présenté ci-dessous:

/**********************************************************
This function does something special...

param1: ...
param2:

RETURNED VALUES:
...
**********************************************************/
function something(...)
{
   ...

Et les convertir en fichiers HTML (peut-être avec un menu à gauche frameset). Ne pas besoin de la même syntaxe indiquée ci-dessus, il est seulement un exemple pour expliquer ce que je parle.

Pour que seul un outil donc une fois que j'ai appris la syntaxe à la documentation d'écriture, je peux utiliser la même syntaxe de documentation pour PHP et JavaScript.

Ce serait bien si l'outil était un binaire (.exe) ou un code Java, avec pas besoin d'installer PERL ou PYTHON.

Était-ce utile?

La solution

Doxygen peut gérer PHP hors-the-box, et scripts d'aide sont disponibles pour permettre son utilisation avec JavaScript (ce ne nécessite Perl, cependant).

Autres conseils

Pas d'offense, mais le monde du développement web (PHP en particulier) est encore un monde basé sur Unix principalement. Si vous actualisant automatiquement tout ce qui est basé sur Perl, Python, ou un autre langage de script (comme PHP!), Vos options chuter de façon spectaculaire, surtout si vous ne voulez pas payer pour cela.

Vous devriez être en mesure d'installer les binaires Perl et il suffit d'exécuter un script ...

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