Como documentar um Evento (class Event)?

Data de postagem: Nov 16, 2010 2:1:32 PM

Um Evento deve ser documentado semelhante à forma como se documentam getter's e setter's. O exemplo abaixo mostra a documentação sugerida. As diferenças estão destacadas em vermelho logo abaixo:

/**

* Event Description.

* @type Event

* @param1 {Type} paramName Description

* @param2 {Type} paramName Description

*/

/*jsdoc FunctionName.prototype.onEventName = function() {} jsdoc*/

/** @private */

FunctionName.prototype._onEventName = null;

/** @private */

FunctionName.prototype.getOnEventName = function (){};

/** @private */

FunctionName.prototype.setOnEventName = function (){};

A documentação acima irá gerar o seguinte resultado (JSDoc):

{Event} onEventName(param1, param2)

Event Description.

Parameters:

param1

Description 1

param2

Description 2

Disponibilizamos o CodeTemplate (acessível na IDE através do Ctrl+J) de nome: docEvent (Event Documentation) para auxiliar nessa documentação.