dimanche 24 février 2013

Documentation de code ExtJS

sencha

Vous connaissez le site de documentation ExtJS ? Vous voulez faire la même chose pour votre code ? C'est possible grâce à JsDuck.

Pour un démarrage rapide, il suffit d'installer ruby, gem et JsDuck:

 # gem install jsduck

puis de lancer l'outil sur votre code:

 $ jsduck --output votre/docs

On peut également utiliser un fichier de configuration json pour personnaliser tout ça (option --config).

Dans votre code, il suffit d'ajouter des commentaires du type:

 /**
  * commentaire d'objet, méthode ou attribut
  ...
  */

et d'utiliser certaines annotations du type

 @param {type} nom description ....

ou

 @return {type} description

Lisez la documentation pour plus de détails