Javascript Girl
  1. Javascript Girl
  3. Comment faire pour jsDoc des héritages multiples ou des mixins?
Intereting Posts
Flot 0.8.2 Graphique de ligne – Bogue de couleur Comment empêcher le changement de propriété sur JS angulaire Comment éviter le clic-droit du navigateur? Définition de variable Javascript, qu'est-ce que var win = window.dialogArguments || Ouvreur || Parent || Haut; faire? JQuery Select Box and Loop Help La différence entre 2 dates en JavaScript? Comment puis-je forcer les clients à actualiser les fichiers JavaScript? Erreur Webpack avec réaction Comment gérer mes données JSON dans le retour de jQuery Ajax? Javascript: Vérifiez si le serveur est en ligne? JQuery / Twitter Bootstrap data-loading-text button with delay Comment ajouter 30 minutes à un objet Date JavaScript? Comment créer une API de diffusion avec NodeJS Erreur: Impossible de définir les en-têtes après leur envoi au client Obtenez efficacement les coordonnées d'une zone visible de l'élément

Comment faire pour jsDoc des héritages multiples ou des mixins?

Comment documenter les mixins ou l'héritage multiple? 

/** * @class Parent */ function Parent() { } Parent.prototype.parentTest = 5; /** * @class Mixin */ function Mixin() { } Mixin.prototype.mixinTest = 5; /** * @class Child * @augments Parent * @mixin Mixin */ function Child() { }

Y at-il quelque chose de officiel de JsDoc? Sinon, comment préférez-vous qu'il soit écrit?

Les @augments multiples sont effectivement pris en charge par JsDoc Toolkit (je n'ai pas essayé, mais leurs tests unitaires le suggèrent, recherchez "multiple").

Pour les Mixins, vous pouvez utiliser @lends et @borrows , voir les exemples ici: http://code.google.com/p/jsdoc-toolkit/wiki/CookBook

Que diriez-vous: 

 @mixin [<MixinName>]

Ajouter à tous les objets qui se mélangent: 

 @mixes <OtherObjectPath>

Tiré du lien de documentation : 

 /** * This provides methods used for event handling. It's not meant to * be used directly. * * @mixin */ var Eventful = { /** * Register a handler function to be called whenever this event is fired. * @param {string} eventName - Name of the event. * @param {function(Object)} handler - The handler to call. */ on: function(eventName, handler) { // code... }, /** * Fire an event, causing all handlers for that event name to run. * @param {string} eventName - Name of the event. * @param {Object} eventData - The data provided to each handler. */ fire: function(eventName, eventData) { // code... } }; /** * @constructor FormButton * @mixes Eventful */ var FormButton = function() { // code... }; FormButton.prototype.press = function() { this.fire('press', {}); } mix(Eventful).into(FormButton.prototype);