web-dev-qa-db-fra.com

Comment documenter les propriétés de l'objet dans la balise JSDoc 3: @this

Le @param tag permet la documentation des propriétés, par exemple.

 /**
  * @param {Object} userInfo Information about the user.
  * @param {String} userInfo.name The name of the user.
  * @param {String} userInfo.email The email of the user.
  */

Comment documenter les propriétés de la balise @this?

 /**
  * @this {Object} 
  * @param {String} this.name The name of the user.
  * @param {String} this.email The email of the user.
  */

Je me demande si quelqu'un qui travaille sur le projet le sait. (Les documents sont toujours en cours de création ...)

thisjsdoc
36
Matt

Pour documenter les membres d'instance, utilisez @name Class#member:

/**
  Construct a new component

  @class Component
  @classdesc A generic component

  @param {Object} options - Options to initialize the component with
  @param {String} options.name - This component's name, sets {@link Component#name}
  @param {Boolean} options.visible - Whether this component is vislble, sets {@link Component#visible}
*/
function Component(options) {
  /**
    Whether this component is visible or not

    @name Component#visible
    @type Boolean
    @default false
  */
  this.visible = options.visible;

  /**
    This component's name

    @name Component#name
    @type String
    @default "Component"
    @readonly
  */
  Object.defineProperty(this, 'name', {
    value: options.name || 'Component',
    writable: false
  });
}

Il en résulte une section Membres dans la documentation qui répertorie chaque membre, son type, sa valeur par défaut et s'il est en lecture seule.

La sortie telle que générée par [email protected] ressemble à ceci:

JSDoc3 output

Voir également:

54
lazd

Utilisez le @property tag pour décrire l'attribut d'un objet.

@param est utilisé pour définir les paramètres d'une méthode ou d'un constructeur.

@this est utilisé pour définir à quel objet this fait référence. Voici donc un exemple utilisant JSDOC 3.

/**
* @class Person
* @classdesc A person object that only takes in names.
* @property {String} this.name - The name of the Person.
* @param {String} name - The name that will be supplied to this.name.
* @this Person
*/
var Person = function( name ){
    this.name = name;
};

JSDOC 3: https://github.com/jsdoc3/jsdoc

Plus d'informations: http://usejsdoc.org/index.html

Plus d'informations: http://code.google.com/p/jsdoc-toolkit/wiki/TagParam

5
Larry Battle

Au sein du constructeur d'une classe, jsdoc se rendra compte par lui-même que les propriétés documentées appartiennent aux instances de classe. Cela devrait donc suffire:

/**
 * @classdesc My little class.
 *
 * @class
 * @memberof module:MyModule
 * @param {*} myParam Constructor parameter.
 */
function MyLittleClass(myParam) {
    /**
     * Instance property.
     * @type {string}
     */
    this.myProp = 'foo';
}

S'il n'est pas clair pour jsdoc que la fonction est le constructeur de classe, vous pouvez utiliser @this pour définir à quoi this fait référence:

/**
 * @classdesc My little class.
 *
 * @class
 * @memberof module:MyModule
 * @name MyLittleClass
 * @param {*} myParam Constructor parameter.
 */

// Somewhere else, the constructor is defined:
/**
 * @this module:MyModule.MyLittleClass
 */
function(myParam) {
    /**
     * Instance property.
     * @type {string}
     */
    this.myProp = 'foo';
}
1
Ignitor