Estou escrevendo minha própria biblioteca para o projeto no trabalho para um aplicativo de navegador e estou tendo o mesmo problema antigo de decidir como comentar o código.

Estou tentando seguir oJsDoc sintaxe, mas provavelmente continuará aCompilador do Google Closure caminho. Eu posso acabar usando duas tags @return e @returns na documentação, apenas por portabilidade (quando configuro a geração automática da documentação).

Agora, a questãoComo você documenta o retorno de um objeto anônimo personalizado de uma função? Por exemplo:

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

O JsDoc possui um exemplo de como um @param pode ser documentado para esperar o objeto com determinados campos, mas não a tag @returns. Da mesma forma, a documentação do Google Closure Compiler de um tipo de registro é vaga e não tem nenhum exemplo para resolvê-lo.