Ich schreibe meine eigene Bibliothek für das Projekt bei der Arbeit für eine Browseranwendung und habe das gleiche alte Problem bei der Entscheidung, wie der Code kommentiert werden soll.

Ich versuche dem zu folgenJsDoc Syntax, wird aber wohl die fortsetzenGoogle Closure Compiler Weg. Aus Gründen der Portabilität verwende ich möglicherweise zwei @return- und @returns-Tags in der Dokumentation (wenn ich die automatische Generierung der Dokumentation einstelle).

Nun ist die Frage,Wie dokumentieren Sie die Rückgabe eines benutzerdefinierten anonymen Objekts von einer Funktion? Zum Beispiel:

return {
    username: 'username',
    password: 'password',
    enabled:  true
};

JsDoc hat ein Beispiel dafür, wie ein @Param so dokumentiert werden kann, dass es Objekte mit bestimmten Feldern erwartet, jedoch nicht mit dem @Returns-Tag. In ähnlicher Weise ist die Dokumentation eines Datensatztyps zum Google Closure Compiler vage und enthält kein Beispiel, um dies herauszufinden.