Instalation de jsdoc-toolkit
L'installation de jsdoc-toolkit est assez simple puisque qu'il s'agit juste de dé-zipper le fichier télécharger, du moins sous Windows 7.
Il faut aussi Java(TM) SE Runtime Environment (build 1.6.0_03-b05)
disponible sur le site de Java
Voir le site : http://code.google.com/p/jsdoc-toolkit/downloads/listIl faut aussi Java(TM) SE Runtime Environment (build 1.6.0_03-b05)
disponible sur le site de Java
Générer la documentation HTML de votre javascript
C'est là que cela devient un peu plus complexe.
Nous imaginerons que pour cet exemple que le répertoire dé-zipper se trouve dans C:Users/NOM/Downloads/jsdoc_toolkit-2.4.0.
1) Récupérez l'exemple de code Javascript sur Wikipédia.
* Creates an instance of Circle.
*
* @constructor
* @this {Circle}
* @param {number} r The desired radius of the circle.
*/
function Circle(r) {
/** @private */ this.radius = r;
/** @private */ this.circumference = 2 * Math.PI * r;
}
[....]
Mettez le code Javascript dans un fichier nommé exemple.js qui ce trouvera dans C:Users/NOM/Downloads/jsdoc_toolkit-2.4.0/jsdoc-toolkit.
2) Ouvrir la console de commande Windows
Sous Windows 7 : C:WindowsSystem32cmd.exe
3) Allez dans le bon répertoire.
Il faut mettre la console dans le bon répertoire voici quelques commandes qui vous permettrons de le faire :
cd .. =>pour revenir au dossier supérieur
cd NOM_DOSSIER =>pour aller dans un dossier enfant
cd CHEMIM_ABSOLUT =>pour aller dans un dossier précis (exemple ci-dessus)
Touche Entrée pour valider.
La touche Tabulation vous permet d'afficher les dossiers fils un par un.
3) Générer la documentation JsDoc.
Dans la console saisissez le code suivant :
Si tout ce passe bien, la documentation JsDoc se trouve dans C:Users/NOM/Downloads/jsdoc_toolkit-2.4.0/jsdoc-toolkit/out/jsdoc/
Voir le site : http://code.google.com/p/jsdoc-toolkit/wiki/CommandlineOptionsNous imaginerons que pour cet exemple que le répertoire dé-zipper se trouve dans C:Users/NOM/Downloads/jsdoc_toolkit-2.4.0.
1) Récupérez l'exemple de code Javascript sur Wikipédia.
Exemple de code :
/*** Creates an instance of Circle.
*
* @constructor
* @this {Circle}
* @param {number} r The desired radius of the circle.
*/
function Circle(r) {
/** @private */ this.radius = r;
/** @private */ this.circumference = 2 * Math.PI * r;
}
[....]
Mettez le code Javascript dans un fichier nommé exemple.js qui ce trouvera dans C:Users/NOM/Downloads/jsdoc_toolkit-2.4.0/jsdoc-toolkit.
2) Ouvrir la console de commande Windows
Sous Windows 7 : C:WindowsSystem32cmd.exe
3) Allez dans le bon répertoire.
Il faut mettre la console dans le bon répertoire voici quelques commandes qui vous permettrons de le faire :
Exemple de code :
LETTRE_DISQUE: => pour changer de disque (C,D...)cd .. =>pour revenir au dossier supérieur
cd NOM_DOSSIER =>pour aller dans un dossier enfant
cd CHEMIM_ABSOLUT =>pour aller dans un dossier précis (exemple ci-dessus)
Touche Entrée pour valider.
La touche Tabulation vous permet d'afficher les dossiers fils un par un.
Exemple de code :
cd [touche tabulation]3) Générer la documentation JsDoc.
Dans la console saisissez le code suivant :
Exemple de code :
java -jar jsrun.jar app/run.js exemple.js -t=templates/jsdocSi tout ce passe bien, la documentation JsDoc se trouve dans C:Users/NOM/Downloads/jsdoc_toolkit-2.4.0/jsdoc-toolkit/out/jsdoc/
Chemins de la source et de la sortie de JsDoc
Une fois que vous avez réussit à générer la documentation Javascript.
Nous allons voir comment choisir les fichiers sources et l'endroit ou sera générée la documentation jsDoc.
Pour changer les sources Javascript dont vous voulez générer une documentation jsDoc, vous pouvez mettre plusieurs noms de fichiers :
ou un nom de répertoire :
ou un mélange des deux :
Pour changer de répertoire de génération de la documentation jsDoc vous devez utiliser la commande -d=CHEMIN
Par défaut, jsdoc-toolkit ne documente que les fonctions commentées, pour prendre en compte toutes les fonctions utilisez -a
Voir le site : http://code.google.com/p/jsdoc-toolkit/wiki/CommandlineOptionsNous allons voir comment choisir les fichiers sources et l'endroit ou sera générée la documentation jsDoc.
Exemple de code :
java -jar jsrun.jar app/run.js [MES_COMMANDES] -t=templates/jsdocPour changer les sources Javascript dont vous voulez générer une documentation jsDoc, vous pouvez mettre plusieurs noms de fichiers :
Exemple de code :
java -jar jsrun.jar app/run.js D:/web/js/fichier_1.js G:/web2/js/fichier_3.js -t=templates/jsdocExemple de code :
java -jar jsrun.jar app/run.js D:/web/js -t=templates/jsdocExemple de code :
java -jar jsrun.jar app/run.js D:/web/js D:/web2/js/fichier_1.js -t=templates/jsdocPour changer de répertoire de génération de la documentation jsDoc vous devez utiliser la commande -d=CHEMIN
Exemple de code :
java -jar jsrun.jar app/run.js D:/web/js/ -d=D:/web/__doc -t=templates/jsdocPar défaut, jsdoc-toolkit ne documente que les fonctions commentées, pour prendre en compte toutes les fonctions utilisez -a
Exemple de code :
java -jar jsrun.jar app/run.js D:/web/js/ -a -d=D:/web/__doc -t=templates/jsdoc
