Wie kann man angeben, dass param optional ist, wenn man JSDoc inline verwendet?

Entsprechend der JSDoc-wiki für @param geben Sie an @param ist optional mit

/**
    @param {String} [name]
*/
function getPerson(name) {
}

und Sie kann auf eine param inline mit

function getPerson(/**String*/ name) {
}

Und ich kann Sie kombinieren, wie die folgende, die funktioniert ok.

/**
    @param [name]
*/
function getPerson(/**String*/name) {
}

Aber ich würde gerne wissen, ob es eine Möglichkeit gibt, es zu tun alle inline-falls möglich.

InformationsquelleAutor der Frage studgeek | 2011-05-03

  1. 49

    Nach einigem Graben fand ich diese ok sind sowie

    /**
 * @param {MyClass|undefined}
 * @param {MyClass=}
 * @param {String} [accessLevel="author"] The user accessLevel is optional.
 * @param {String} [accessLevel] The user accessLevel is optional.
 */

    Nur etwas mehr optisch Ansprechend als function test(/**String=*/arg) {}

    InformationsquelleAutor der Antwort vvMINOvv

  2. 47

    Vom offizielle Dokumentation:

    Optionale parameter

    Einen optionalen parameter namens foo.

    @param {number} [foo]
//or:
@param {number=} foo

    Einen optionalen parameter foo mit default-Wert 1.

    @param {number} [foo=1]

    InformationsquelleAutor der Antwort czerny

  3. 40

    Habe ich einen Weg gefunden, dies zu tun mit Google Closure Compiler geben Sie Ausdrücke. Setzen Sie ein Gleichheitszeichen nach der Art wie:
    function test(/**String=*/arg) {}

    InformationsquelleAutor der Antwort studgeek

Schreibe einen Kommentar