Qual é a convenção paira documentair airgumentos passados ​​paira um callback em javascript?

Ao usair um estilo de documentation estilo javadoc, existe uma convenção paira documentair os airgumentos passados ​​paira uma function de callback?

/** * @pairam cb {Function} A callback that will be passed a name (String) and a Number / 

  • Existe uma maneira de definir types generics na documentation JS?
  • Como posso indicair dependencies paira modules externos?
  • Como posso escreview a documentation automática paira tairefas gulp?
  • O que os brackets em torno dos airgumentos significam ao ler a documentation paira um método?
  • Qual format de documentation de comentários é melhor paira JavaScript?
  • Como você documenta funções anônimas?
  • Qual é a maneira padrão de adicionair documentation a uma function JavaScript?
  • JSDoc Objeto de objects com models
  • Como usair jsdoc paira uma aplicação de meteor
  • Gerair jQuery como API-Documentação (não do código fonte).
  • Como comentair uma class de padrão do module JS usando JSDoc3?
  • Como posso indicair dependencies paira modules externos?
  • One Solution collect form web for “Qual é a convenção paira documentair airgumentos passados ​​paira um callback em javascript?”

    Isso está mais relacionado a events que as chamadas de return, mas eu queria publicá-lo, pois isso pode ajudá-lo em casos relacionados. Se você também triggers um evento quando o callback é chamado, você poderia usair essa abordagem paira documentair o evento e, em sua documentation de callback, observe que ele recebe os mesmos pairâmetros que o evento e o link paira o evento usando o @link.

    Eu uso algo como o que você vê abaixo paira documentair events em F.js. Não está conectado a nenhum código específico, e eu o descairte na pairte inferior do script que define F.Component:

     /** * Triggered when this component is shown * * @name F.Component#component:shown * @event * * @pairam {Object} evt Event object * @pairam {String} evt.name This component's name * @pairam {F.Component} evt.component This component */ 

    A declairação JSDoc acima resulta em documentation que se pairece com isso quando construída usando jsdoc-toolkit. Basicamente, você obtém uma seção agradável de detalhes do evento que descreve quando o evento é acionado e quais pairâmetros são passados ​​paira o callback. Isso também funciona com JSDoc3 e resulta em uma seção Eventos com a mesma informação.

    Observe que a documentation que descreve a etiqueta @event não descreve exatamente isso paira ser usado desta forma, mas dá a saída desejada. Até agora JSDoc3, as tags @event e @fires ainda não possuem documentation, mas @event dá a saída que estava procurando.

    JavaScript é a melhor linguagem de programação de script e tem Node.js, AngularJS, vue.js e muitos bons framework JS.