Я пишу свою собственную библиотеку для проекта на работе для приложения для браузера, и у меня возникла та же старая проблема, когда я решал, как комментировать код.

Я пытаюсь следоватьJSDoc синтаксис, но, вероятно, продолжитGoogle Closure Compiler путь. Я могу использовать два тега @return и @returns в документации, просто для удобства переносимости (когда я настраиваю автогенерацию документации).

Теперь вопрос,how do you document the return of a custom anonymous object from a function? Например:

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

В JsDoc есть пример того, как @param может быть задокументирован, чтобы ожидать объект с определенными полями, но не тег @returns. Точно так же документация Google Closure Compiler с типом записи является расплывчатой и не имеет примера для ее решения.