Я пишу свою собственную библиотеку для проекта на работе для браузерного приложения, и у меня та же старая проблема, связанная с тем, как комментировать код.
Я пытаюсь следовать синтаксису JsDoc, но, вероятно, продолжу путь Google Closure Compiler. Я могу в конечном итоге использовать два тега @return и @returns в документации только для переносимости (когда я настраиваю автоматическое создание документации).
Теперь вопрос: как вы документируете возврат пользовательского анонимного объекта из функции? Например:
return {
username: 'username',
password: 'password',
enabled: true
};
В JsDoc есть пример того, как можно задокументировать @param для ожидания объекта с определенными полями, но не с тегом @returns. Точно так же документация Google Closure Compiler для типа записи расплывчата и не содержит примеров для его работы.