15
Gibt es eine Liste von gültigen Typen für param-Tags für jsdoc? Zum Beispieljsdoc gültige Param-Typen
@param {type} myParam Some parameter description
Ich weiß, dass Dinge wie number und String gültig sind, aber was, wenn ich will dokumentieren, dass die Zahl eine ganze Zahl ist. Ist int gültig?
Ich habe etwas gegoogelt, aber ich kann nicht scheinen, eine vollständige Liste zu finden.
Ich habe festgestellt, dass Werkzeuge in der Regel nur die Zeichenfolgen in Tokens zerlegen, also spielt es keine Rolle. Ich habe nur gehofft, dass es einige Standardtypen gibt. Das JavaScript-System scheint nicht ausdrucksvoll genug zu sein (z. B. Zahl ist nicht sehr spezifisch), aber es gibt Optionen, wie Sie oben gezeigt haben. –
Man kann alles in die {} einfügen, aber es wäre schön zu wissen, was die Konventionen sind, nein? Gibt es wirklich keine Liste? Wie gibt es eine Konvention für die Spezifizierung eines Prototyp-Objekts, oder sollte das @param {Object} ... sein? – fraxture
Für den JSDoc-Generator (https://github.com/jsdoc3/jsdoc) wird in http://usejsdoc.org/tags-param.html gesagt: "Der Parametertyp kann ein eingebauter JavaScript-Typ sein, wie z als Zeichenfolge oder Objekt oder ein JSDoc-Namenspfad zu einem anderen Symbol in Ihrem Code. " Im Falle eines Symbols in Ihrem Code wird ein Link zu seiner Definition generiert. Die integrierten Typen werden jedoch weiterhin als Zeichenfolgen angezeigt, sodass z. zwischen '{string}' und '{String}'. Auch erkennt z. B. PhpStorm beide, aber beschwert sich über '{array}', während '{Array}' akzeptiert wird. –