Estoy escribiendo mi propia biblioteca para el proyecto en el trabajo para una aplicación de navegador y tengo el mismo viejo problema de decidir cómo comentar el código.

Estoy tratando de seguir elJsDoc sintaxis, pero probablemente continuará laCompilador de cierre de Google camino. Es posible que termine usando dos etiquetas @return y @returns en la documentación, solo por motivos de portabilidad (cuando configuro la autogeneración de la documentación).

Ahora, la pregunta,¿Cómo se documenta la devolución de un objeto anónimo personalizado desde una función? Por ejemplo:

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

JsDoc tiene un ejemplo de cómo se puede documentar un @param para que espere un objeto con ciertos campos, pero no con la etiqueta @returns. De manera similar, la documentación de Google Closure Compiler de un tipo de registro es vaga y no tiene ningún ejemplo para resolverlo.