Ou font-ils et ce n'est pas dans la source? Je voudrais vraiment obtenir quelque chose qui va arrêter js-doc-guide pratique de flipper à chaque fois qu'il traite de jQuery. Cela signifie aussi que je ne peux pas bien documenter le code en utilisant jQuery comme une dépendance sans au moins mettre un peu passe-partout js-doc blocs, qui ne sont pas correctement document de jQuery structure. Est-il une solution commune, je ne suis pas au courant? J'ai essayé de googler, btw.
Réponses
Trop de publicités?
Je vais prendre un coup de feu dans l'obscurité ici car je ne peux pas parler pour le jQuery équipe de pourquoi je ne voudrais pas l'utiliser JSDoc. JSDoc, au moins la dernière fois que j'ai vérifié, n'ont pas de moyen propre à soutenir la surcharge de méthode (ou d'un paramètre de décalage...quel que soit le nom que vous voulez donner ici) et jQuery utilise ce tous sur la place. Prenons un simple exemple commun avec .animate():
.animate({ height: 5 })
.animate({ height: 5 }, 100)
.animate({ height: 5 }, 100, "linear")
.animate({ height: 5 }, 100, "linear", func)
.animate({ height: 5 }, 100, func)
.animate({ height: 5 }, func)
.animate({ height: 5 }, { duration: 100, queue: false })
.animate({ height: 5 }, { duration: 100, easing: "linear" })
.animate({ height: 5 }, { duration: 100, easing: "linear", complete: func })
Tous ces éléments sont valides dans la mesure où les types des paramètres sont contrôlés et décalé en tant que de besoin à l'appui de toute surcharge de scénarios possibles...ce confond tout simplement l'enfer hors de JSDoc, il n'y a aucun moyen propre pour ajouter ces paramètres facultatifs à la documentation. S'il vous plaît corrigez-moi si cela a changé, mais le dernier que j'ai regardé (et probablement la dernière fois que l'équipe a pris un coup d'oeil) c'était toujours le cas.
Une autre considération est de savoir comment certaines méthodes sont générés lorsque jQuery fonctionne, par exemple (un des nombreux), presque tous les gestionnaire d'événements raccourcis sont générés dans une boucle un comportement similaire pour d'autres méthodes...comment vous documenter ces? JSDoc génération, il ne fonctionne vraiment pas bien ici.
ʟɿʠʆɜʣʑɭʟʂɪəɬɸʛʌʢɑʓʔ
Points
61
Ne sais pas pourquoi ils n'ajoutez pas de JSDoc commentaire, mais le Google Fermeture gars semblent garder une version mise à jour de la "externes" dont ils ont besoin pour le compilateur de fermeture avec optimisation avancée
http://code.google.com/p/closure-compiler/source/browse/trunk/contrib/externs/jquery-1.6.js?r=1152
Jasmine Hegman
Points
152
Bien que je ne peut pas ajouter quoi que ce soit d'autre que les autres n'ont pas quant à la question d'origine, je peux fournir un lien vers quelque chose qui PEUT automatiquement document jQuery.
Elle le fait en l'exécutant dans un environnement d'exécution, puis l'analyse de la résultante des arbres. Comme JSDoc il utilise une version modifiée de Rhino. C'est à ses balbutiements, mais j'espère que cela est utile pour quelqu'un. :)
