Documentazione Javascript

Developer
May 4, 2010 at 10:52 AM

Posto il tool che abbiamo utilizzato con la GUI per preparare la documentazione.

JsDoc-Toolkit

Nel wiki del sito ci sono le informazioni base per capirne il funzionamento.
Il progetto è un estensione di Doxygen per javascript e qui si può trovare la lista dei tag utilizzabili con la descrizione di sintassi e semantica.

Il tool per windows è un .jar e può essere lanciato così
java -jar jsrun.jar app\run.js -a -t=templates\jsdoc "Mio-file-javascript.js"

Per linux viene fornito un file bash che ha più o meno la stessa sintassi (sta tutto nel file README.txt)

Fra non molto faremo la commit dei file GUI con i commenti con la giusta sintassi che possono essere usati come esempi.

Buon Lavoro