Connaissez-vous le projet JSDoc (http://sourceforge.net/projects/jsdoc) ? Sa
découverte a fait mon bonheur et j'espère qu'elle fera aussi le vôtre !
JSDoc est un équivalent JavaScript au fameux Javadoc des développeurs Java.
L'outil permet de générer la documentation de votre code JavaScript à partir
de commentaires "à la Javadoc". La version 1.9.5.3 est disponible depuis le
11 juillet.
Je vous laisse consulter son site pour en apprendre plus sur ce fabuleux
outil, n'oubliez surtout pas de passer par la page exemple
(http://jsdoc.sourceforge.net/example/index.html) pour voir le genre de
documentation que l'on peut obtenir.
JSDoc reste donc un excellent outil pour documenter votre code, un bon
complément à Doxygen (http://www.stack.nl/~dimitri/doxygen) par exemple...
qui ne supporte pas JavaScript... enfin pas encore :).
n'oubliez surtout pas de passer par la page exemple
je n'y ai pas manqué vu que sur l'autre il n'y a aucune explication explicative (sauf par comparaison à d'autres utilitaires)
(http://jsdoc.sourceforge.net/example/index.html) pour voir le genre de documentation que l'on peut obtenir.
j'ai rien compris aux fonctions exposées (comment, où, les employer) la doc doit pas être si bien que çà ...
j'ai rien compris de l'utilité d'un outil de documentation surchargeant du code avec du verbiage pas en fr
c'est jsDoc qui pond tout seul de lui même les commentaires ?
JSDoc reste donc un excellent outil pour documenter votre code,
comme par exemple (? !) :
field detail =========== X Object x
oui, ça pour être de la doc c'est de la doc !
-- Stephane Moriaux et son [moins] vieux Mac
Christophe M
Jean-Marc Molina wrote:
Bonjour,
n'oubliez surtout pas de passer par la page exemple
je n'y ai pas manqué vu que sur l'autre il n'y a aucune explication explicative (sauf par comparaison à d'autres utilitaires)
La première c'est la page du projet sur sourceforge, qui donne accès à tous les détails du projet, comme le download du programme, mais aussi la "home page" : http://jsdoc.sourceforge.net/
Elle est beaucoup plus explicite.
(http://jsdoc.sourceforge.net/example/index.html) pour voir le genre de documentation que l'on peut obtenir.
j'ai rien compris aux fonctions exposées (comment, où, les employer) la doc doit pas être si bien que çà ...
j'ai rien compris de l'utilité d'un outil de documentation surchargeant du code avec du verbiage pas en fr
c'est jsDoc qui pond tout seul de lui même les commentaires ?
Non, tout comme l'outil javadoc, JSDoc extrait les commentaires du source des programmes Javascript, pour en faire une documentation technique. Dans l'exemple, on a sur la gauche la liste des objets présents dans la librairie Javascript, pouvant être utilisés, et quand on en choisi 1, à droite apparait la liste des méthodes, l'héritage des classes éventuel (sait pas si c'est géré en js, mais en hava oui) ainsi que pour chaque méthode les explications de "à quoi ça sert".
Evidemment, ça demande au programmeur de documenter son code...
Jean-Marc Molina wrote:
Bonjour,
n'oubliez surtout pas de passer par la page exemple
je n'y ai pas manqué vu que sur l'autre il n'y a aucune explication
explicative (sauf par comparaison à d'autres utilitaires)
La première c'est la page du projet sur sourceforge, qui donne accès à
tous les détails du projet, comme le download du programme, mais aussi
la "home page" : http://jsdoc.sourceforge.net/
Elle est beaucoup plus explicite.
(http://jsdoc.sourceforge.net/example/index.html) pour voir le genre de
documentation que l'on peut obtenir.
j'ai rien compris aux fonctions exposées (comment, où, les employer)
la doc doit pas être si bien que çà ...
j'ai rien compris de l'utilité d'un outil de documentation
surchargeant du code avec du verbiage pas en fr
c'est jsDoc qui pond tout seul de lui même les commentaires ?
Non, tout comme l'outil javadoc, JSDoc extrait les commentaires du
source des programmes Javascript, pour en faire une documentation
technique. Dans l'exemple, on a sur la gauche la liste des objets
présents dans la librairie Javascript, pouvant être utilisés, et quand
on en choisi 1, à droite apparait la liste des méthodes, l'héritage des
classes éventuel (sait pas si c'est géré en js, mais en hava oui) ainsi
que pour chaque méthode les explications de "à quoi ça sert".
Evidemment, ça demande au programmeur de documenter son code...
n'oubliez surtout pas de passer par la page exemple
je n'y ai pas manqué vu que sur l'autre il n'y a aucune explication explicative (sauf par comparaison à d'autres utilitaires)
La première c'est la page du projet sur sourceforge, qui donne accès à tous les détails du projet, comme le download du programme, mais aussi la "home page" : http://jsdoc.sourceforge.net/
Elle est beaucoup plus explicite.
(http://jsdoc.sourceforge.net/example/index.html) pour voir le genre de documentation que l'on peut obtenir.
j'ai rien compris aux fonctions exposées (comment, où, les employer) la doc doit pas être si bien que çà ...
j'ai rien compris de l'utilité d'un outil de documentation surchargeant du code avec du verbiage pas en fr
c'est jsDoc qui pond tout seul de lui même les commentaires ?
Non, tout comme l'outil javadoc, JSDoc extrait les commentaires du source des programmes Javascript, pour en faire une documentation technique. Dans l'exemple, on a sur la gauche la liste des objets présents dans la librairie Javascript, pouvant être utilisés, et quand on en choisi 1, à droite apparait la liste des méthodes, l'héritage des classes éventuel (sait pas si c'est géré en js, mais en hava oui) ainsi que pour chaque méthode les explications de "à quoi ça sert".
Evidemment, ça demande au programmeur de documenter son code...
Jean-Marc Molina
Pour ceux que le sujet intéresse je vous invite à suivre la discussion-miroir "JSDoc : outil de documentation JavaScript" : http://www.developpez.net/forums/viewtopic.php?t73677. On présente notamment un jeu de fonctions, une classe et la documentation générée par JSDoc à partir de tout ce petit monde.
-- Jean-Marc.
Pour ceux que le sujet intéresse je vous invite à suivre la
discussion-miroir "JSDoc : outil de documentation JavaScript" :
http://www.developpez.net/forums/viewtopic.php?t73677. On présente
notamment un jeu de fonctions, une classe et la documentation générée par
JSDoc à partir de tout ce petit monde.
Pour ceux que le sujet intéresse je vous invite à suivre la discussion-miroir "JSDoc : outil de documentation JavaScript" : http://www.developpez.net/forums/viewtopic.php?t73677. On présente notamment un jeu de fonctions, une classe et la documentation générée par JSDoc à partir de tout ce petit monde.
