Documentation du code Javascript

Question

Je suis le développement d'un site qui se développe un peu complexe et j'ai donc commencé à documenter mon code.

Pour le PHP, j'ai utilisé PHPDocumentor; en tout cas, il semble que n'importe quel autre outil (comme Doxygen) serait d'accepter les mêmes balises.

Maintenant, je veux le document de la JS côté. Je vois au moins JSDoc et ScriptDoc (et probablement d'autres) existent, et ils acceptent les différentes balises, donc je devrais faire un choix. Qu'est-ce que la norme (le cas échéant) pour la documentation de code Javascript?

Et d'ailleurs, comment sont-ils utilisés? Il semble ScriptDoc est intégré dans Aptana studio, donc est-il possible de l'utiliser sans l'IDE?

Answer 1

Il n'est pas vraiment une façon "standard" de la documentation de code JavaScript.

Le JSDoc projet n'est plus actif, vous devez donner un coup d'oeil à JsDoc Toolkit.

Il y a d'autres bonnes alternatives, les projets suivants sont très bonnes:

• YUIDoc
• PDoc

Sur ScriptDoc, je pense que c'est axée sur l'activation de l' assistance de Code fonctionnalités sur Aptana, plutôt que de générer des fichiers de documentation.

Answer 2

Il n'est pas écrasante standard pour les JS de la documentation, mais il y a des tendances.

Docco est utilisé par de nombreux populaire, active JS projets, y compris l'épine Dorsale & trait de Soulignement. C'est simple, et a de grands exemples à droite sur la page d'accueil.

JSDoc Toolkit est plus, et de moins en moins populaire pour de nouveaux projets. Le JSDoc site manque aussi des exemples de JSDoc code. Elle nécessite également de Rhino, qui peut être difficile à installer sur Windows par rapport à NodeJS.