Wie kann man in JsDoc eine Leere zurückgeben?

Question

Gibt es eine bestimmte Art und Weise zu erklären, eine Methode oder eine Funktion, um void in JsDoc zurück? Derzeit bin ich der Meinung, dass void ist der Standardrückgabewert, und andere Rückgabewerte müssen ausdrücklich angegeben werden:

/**
 * @return {Integer} The identifier for ...
 */

Answer 1

Verschluss-Compiler

Nach der Dokumentation von Googles Closure Compiler sollte die @return-Annotation weggelassen werden, wenn nichts zurückgegeben wird.

Wenn es keinen Rückgabewert gibt, verwenden Sie kein @return-Tag.

Quelle: https://developers.google.com/closure/compiler/docs/js-for-compiler#tags

jsdoc-toolkit

In der weiteren Dokumentation heißt es jedoch auch, dass returnType und returnDescription optionale Parameter sind.

returnType - Optional: der Typ des Rückgabewerts.

returnDescription - Optional: jede zusätzliche Beschreibung.

Quelle: https://code.google.com/p/jsdoc-toolkit/wiki/TagReturns

Zusammenfassung

Sie können entweder die return-Anmerkung weglassen oder sie ohne Parameter einfügen.

Answer 2

Ich glaube nicht, dass Sie aus einer Reihe von Typen in JsDoc wählen müssen... Sie können jeden beliebigen Typnamen verwenden (die geschweiften Klammern zeigen an, dass es sich um einen Typ handelt), also können Sie einfach tun:

@return {void}

Allerdings ist dies wahrscheinlich eher für JavaScript zutreffend:

@return {undefined}

Answer 3

Ein Blick in die ESlint-Dokumente zeigt, dass sie Folgendes verwenden @returns {void}

Quelle: http://eslint.org/docs/rules/valid-jsdoc

Da ich eine @returns für jede Funktion, um Tests zu bestehen, um Code für bestimmte Projekte zu pushen, ist dies in meinem Fall erforderlich.

Answer 4

Um die Entscheidung zwischen den anderen Antworten zu erleichtern, gibt es einen Vorteil, wenn man ausdrücklich schreibt @return {void} . Obwohl @return kann weggelassen werden, da ein dokumentierender Codierer die @return {void} funktioniert als Gedächtnisstütze. Sie sagt dem Codierer, dass die Rückgabedokumentation geschrieben ist. Wenn es keine @return geschrieben hat, muss der Programmierer möglicherweise überprüfen, ob er vergessen hat, die Dokumentation des Rückgabewerts zu schreiben, oder ob die Funktion wirklich nichts zurückgibt.

Natürlich kann die Dokumentation der Rückgabewerte veraltet sein. Das ist etwas, was der Programmierer nicht direkt aus den Unterlagen erfahren kann, er muss den Code lesen, um das zu überprüfen. Wenn er jedoch sieht, dass der Rückgabewert geschrieben wurde, hat er die Gewissheit, dass die Dokumentation korrekt und nicht nur hastig geschrieben ist.

Answer 5

Ich finde dies weniger zweideutig als das Weglassen des @returns :

@returns {} Nothing is returned.

oder sogar

@returns {} Nothing is returned because this is a broadcast receiver.

Nur eine Idee.