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

Ajouter un commentaire

Le code HTML est affiché comme du texte et les adresses web sont automatiquement transformées.

La discussion continue ailleurs

URL de rétrolien : http://philippe.poumaroux.free.fr/index.php?trackback/101