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

Commentaires

1. Le vendredi 22 avril 2016, 09:06 par BlairTAuyong

Peculiar article, just what I was looking for.

2. Le mardi 26 avril 2016, 06:41 par TamikaJOjard

This design is spectacular! You definitely realize how to
keep a reader amused. Between your wit plus your videos, I used to be almost
moved to start my very own blog (well, almost...HaHa!) Fantastic job.
I really loved what you needed to say, and more than that, the method that you presented it.
Too cool!

3. Le mercredi 27 avril 2016, 06:35 par LoganURois

I am really loving the theme/form of your blog. Do you ever run into any browser compatibility
problems? A handful of my blog readers have complained about my website not working correctly
in Explorer but looks great in Safari. Do you possess any advice to help fix this problem?

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