Discussion :

[rolandcire]

Bonjour,

Je souhaite pouvoir générer une documentation à partir des commentaires insérés dans le code. Je cherche donc un outil de génération automatique...

En Php, il existe par exemple phpDocumentor (http://www.phpdoc.org/) qui va très bien. Je ne parviens pas à trouver un équivalent en javascript.

- J'ai tenté sans succès des outils qui m'ont demandé d'installer Perl auquel je ne connais rien : NaturalDocs (http://www.naturaldocs.org/), jsdoc (http://jsdoc.sourceforge.net/) ou l'excellent Doxygen (mais sa customisation pour Javascript me laisse en échec)
- J'ai tenté jsdoc-toolkit (http://jsdoctoolkit.org/) qui lui demande de fonctionner en Java en ligne de commande (je n'y arrive pas car cela est très loin de ma culture informatique actuelle)
- J'ai tenté la version d'évaluation de "Doc_O_Matic". Cela n'est pas terrible.

Bref, vous l'aurez compris, je suis désespérément à la recherche d'un soft sous Windows permettant de générer aisément de la documentation à partir du code (le style JavaDoc me va très bien).

Par avance merce de vos lumières...
Roalnd Cire

[SpaceFrog]

UN peu plus fastidieux poru en tirer une doc masi ça devrait te convenir

http://jgrouse.com/#main.html

[rolandcire]

Un grand merci pour cette réponse

Je l'avais vu dans mes pérégrinations... Mais je ne sais comment m'en servir.. Je ne me vois pas me lancer dans du Java... Je suis un autodidacte et mes connaissances se limitent à l'univers du Web classique (Php, Javascript, ActionScript...) en environnement Windows. Par effort successif, je passe peu à peu à une programmation objet que je cherche à bien documenter...

Malheureusement, je ne me vois pas me lancer pour l'instant dans un autre univers (Java par exemple)

Une autre idée ?

Merci

[SpaceFrog]

Heu pourquoi aurais tu besoin de te lancer dans java pour tout ces utilitaires ???

[rolandcire]

Merci

Bon, je crois qu'il faut que je retourne voir
http://jgrouse.com/#main.html

[DoubleU]

Apparemment jgrouse nécessite d'utiliser ANT... je suis pas sur que ca soit le plus simple pour un néophyte ^^

Même s'il est en java, l'utilisation de JsDoc ne me parrait pas insurmontable par contre.

[rolandcire]

Merci à vous deux

@SpaceFrog : j'y suis retourné, j'ai aussi chargé ANT et la doc me dit
"To build and use Ant, you must have a JAXP-compliant XML parser installed and available on your classpath, such as Xerces." (...)
Euh, je crois que c'est au dessus de mes capacités actuelles..

@DoubleU : j'y retourne


Grrhh... autant d'embêtements pour générer une malheureuse documentation

---------- EDIT
Bon ben je ne vois pas.
- J'apprécie le type de documentation que jsdoc-toolkit permet de produire (ex : http://archetypejs.org/jsdoc/index.html)
- J'ai Java (jre1.6.0_04) qui est installé
- J'ai jsdoc-toolkit à la racine de c (pour faire simple),
- je lis le wiki (mais je n'y comprends pas grand chose sur Java) mai sne trouve pas de tut clair sur le net pour l'instant
- j'ouvre une fenêtre DOS, je me place dans le répertoire de jsdoc, et je me retrouve comme une poule qui vient de trouver un couteau

[rolandcire]

Comme je tourne en rond sans trouver de piste, je me permets de relancer

- Connaissez-vous des tut pour installer/lancer jsdoc-toolkit (ou même jgrouse) ?

Pour jsdoc, le wiki indique de faire : java -jar app/js.jar app/run.js
Pouvez-vous m'indiquer où entrer ce code (puisque visiblement ce n'est pas dans la fenêtre DOS )

Merci

[DoubleU]

Comme je tourne en rond sans trouver de piste, je me permets de relancer

- Connaissez-vous des tut pour installer/lancer jsdoc-toolkit (ou même jgrouse) ?

Pour jsdoc, le wiki indique de faire : java -jar app/js.jar app/run.js
Pouvez-vous m'indiquer où entrer ce code (puisque visiblement ce n'est pas dans la fenêtre DOS )

Merci

Justement si, c'est dans la console DOS ^^

[rolandcire]

merci (et désolé d'être si "collant")


@ From : DoubleU : "Justement si, c'est dans la console DOS"

Ah ben ça alors ! Comme quoi on part (euh, je pars serait plus exact ) souvent sur de fausses pistes.

Bon, au test cela ne fonctionne cependant pas
- Je lance la console DOS
- Je me rends dans le répertoire contenant jsdoc-toolkit

console : C:\JSDOC

- Je tape le lancement Java indiqué dans le wiki soit :

java -jar app/js.jar app/run.js

-Retour du DOS :

WARNING : No source file to work on

- Je vais vérifier : effectivement le fichier js.jar n'existe pas dans app (alors que run.js existe).
-Je me dis qu'il y a peut-être une petite erreur de localisation.
- Je cherche le fichier : il est dans java/classes.js.jar
- Je retourne dans le DOS, je modifie le chemin en conséquence et là j'obtiens :

C:\JSDOC>java -jar java/classes/js.jar app/run.js
js: uncaught JavaScript runtime exception: TypeError: Cannot call method "match" of undefined

Bouh ... déjà 3 jours sur ce truc. Je ne vois plus comment m'en sortir.

EDIT ------------------ MERCI
Bon finalement j'ai trouvé ailleurs une syntaxe qui cette fois permet de démarrer la bête

java -jar jsrun.jar app/run.js test.js -t=templates/jsdoc

Par contre, jsdoc ne semble pas prendre en compte la documentation de méthodes définies par prototype. Quelqu'un sait-il si c'est pris en compte ou s'il faut une syntaxe particulière ?

[SpaceFrog]

je teste celui là et je vous dit si c'est plus facile
http://jscc.jmksf.com/

j'aurais aussi vite fait d'essayer à apprendre le crochet
c'est d'un clair obscure

[rolandcire]

je teste celui là et je vous dit si c'est plus facile
http://jscc.jmksf.com/

Ah oui super
(Tq : Je ne l'avais pas vu celui-là et pourtant j'ai labouré le web avec Google. Je me demande comment vous avez fait pour le trouver !)

Bon, sinon pour moi c'est finalement OK
Je me coucherai moins c.. ce soir.

Note : Pour les méthodes ajoutés par prototype, j'avais seulement fait une erreur de syntaxe dans la documentation de mon code (il faudra d'ailleurs que je fasse des aménagements à ce propos mais ce n'est pas grave, je ne suis plus à cela près).

Un grand merci à DoubleU et SpaceFrog... en attendant d'en savoir plus à propos de http://jscc.jmksf.com/