Recentemente, tenho procurado em toda a rede pela One True
Way para documentar programas Javascript e devo dizer que estou um pouco
decepcionado. Resumindo, tenho os seguintes requisitos para
documentar Backgrid.js :
- Resumo automático da API com base na assinatura da função
- Capaz de compreender e documentar expressões comuns de JS, como
throwestender um protótipo com um objeto literal, disparar eventos … etc. - Exemplos de código incorporado no Markdown
- Dá mensagens de erro razoáveis
- Salva informações de documentação analisadas em alguns arquivos JSON de metadados
Você poderia pensar que muitas ferramentas fazem isso (porque eles afirmam que
podem), mas aqui está a realidade:
Leia mais no meu Blog Posterous