Was ist der richtige Weg, um Dokument ein jQuery-parameter geben Sie mit JSDoc?

Ich versuche zu dokumentieren, die mein Programm mit der JSDoc-syntax für mich und die Menschen, die sich auf meinen code. Ich versuche auch, meine Sachkenntnisse zu verbessern.

Für einen parameter der jQuery-Typ, ich bin ein wenig verwirrt. Ich weiß, das ist ein Objekt, aber es ist ziemlich normal, in meinem Programm, so dass ich denke, ich sollte zuerst erklären, ein typedef für die jQuery-Typ, dann verwenden Sie es als meine parameter geben. So Frage ich, wäre es der richtige Weg, es zu tun?

/**
 * DOM object referenced by jQuery
 * @typedef {jQuery} $jQueryDomObject
 */

/**
* SOAP call that does ...
*
* @param {string} code Some desc ...
* @param {callback} fnctVa Some desc ...
* @param {$jQueryDomObject} $attrib Input field that ...
*/
myfunction = function (code, fnctVa, $attrib) {};

Fand ich auch auf SO dieser Frage, ähnlich wie:

Wie bekomme ich JSDoc zu markieren, meine param als ein jQuery-Objekt?

  • Die richtige Sache ist, die nicht einen SOAP Aufruf mit einem jQ-Objekt und separepate betrifft. Nur zu sagen. Interessante Frage, dennoch.
  • Ok, ich werde in diese Aussehen. Whould Sie vorschlagen ein Muster statt ?
  • Separation of concerns ist ein Prinzip und nicht ein Muster. Die Idee ist in diesem Fall (es ist anwendbar, um mehr als GUI), die Ihre Präsentations-Logik und business-Logik sollte nicht gemischt werden, wie, dass. Einige gängige design-patterns, das Problem anzugehen, sind mediator, observer-und event-emitter. Einige architektonische Muster, die das Problem beheben werden, MVC, MVVM und MVP.
  • Vielen Dank für die Architektur-Tipp... ok, so dass die GUI nicht sprechen, um die Daten direkt und Umgekehrt. Es bekam.
  • Ich habe viel getan, das gleiche zu dokumentieren legacy-code, dass ich nicht eine hand im schreiben.
InformationsquelleAutor Jean-Philippe Martin | 2013-11-27
  1. 20

    Für einen parameter ein jQuery-Objekt, das ich oft nur:

    @param {jQuery} foo

    Und nicht weiter zu definieren, was jQuery ist. Es ist bekannt genug. Allerdings, wenn Sie möchten, können Sie dies mit jsdoc 3:

    /**
 * jQuery object
 * @external jQuery
 * @see {@link http://api.jquery.com/jQuery/}
 */

/**
 * SOAP call that does ...
 *
 * @param {string} code Some desc ...
 * @param {callback} fnctVa Some desc ...
 * @param {external:jQuery} $attrib Input field that ...
 */
var myfunction = function (code, fnctVa, $attrib) {};
    InformationsquelleAutor Louis
  2. 4

    Sah ich auch auf github/js3doc: 

    @param {jQuery object} obj The jQuery object you're looking for.

    oder github/js3doc

    @param {module:jquery} jquery Some desc...
    InformationsquelleAutor Jean-Philippe Martin
Schreibe einen Kommentar