Documentez vos librairies JavaScript comme des pros !
Comme je n'ai pas trouvé, sur le forum, de références faites à un petit logiciel que j'utilise pour générer de la documentation sur mes libraires JavaScript, je vous fais part ici de ma découverte.
Il s'agit de JSDcoc. JSDoc est un simple script programmé en Perl qui procède de la même manière et avec les mêmes méthodes que JavaDoc, bien connu des développeurs Java. JSDoc génère une documentation d'allure professionnelle en une seule étape qui dure une fraction de seconde.
La doc est générée à partir du code et des commentaires contenus dans vos fichiers JS. Comme le logiciel est écrit en Perl, il peut être installé sur tous les systèmes d'exploitation qui supportent Perl (Linux, Unix, Windows, MacOS ?)...
Voici un exemple généré avec JSDoc dans un petit projet récent : Cliquez ici.
Amusez-vous bien !
Re: Documentez vos librairies JavaScript comme des pros !
Citation:
Envoyé par Claude Pelletier
Comme je n'ai pas trouvé, sur le forum, de références faites à un petit logiciel que j'utilise pour générer de la documentation sur mes libraires JavaScript, je vous fais part ici de ma découverte.
Merci pour ta contribution, mais pour le principe, je me dois de te montrer qu'on en a déjà parlé : http://www.developpez.net/forums/vie...ighlight=jsdoc.
Après, tu peux me dire que je fais vraiment du mauvais esprit, parceque cette remarque est vraiment pas très visible :roll: , ok, je :arrow:
:)
