Documentando o código JavaScript com Doxx

Muitos de nós, programadores, não estamos acostumados em documentar nosso código, mas isso é algo que deve ser feito também de forma profissional. Vamos ver como documentar código JavaScript com Doxx.

O projeto Doxx é uma refatoração do projeto dox, mas usa o Bootstrap como framework CSS. Ambos são módulos Node e podem ser instalados usando o npm:

npm install doxx -g

Para ver se está funcionando, use o comando:

doxx --help

Agora vamos para um exemplo prático. Digamos que você tem uma função chamada hello que imprime uma mensagem no console:

/**
* Imprime uma mensagem no console.
*/
function hello(name){
    console.log("hello, world!");
}

Essa função está no arquivo js/hello.js. A documentação deve seguir o mesmo padrão do JavaDoc. Um README.md na pasta raiz do projeto é usado como página inicial da documentação. O arquivo usa o formato Markdown usado no Git. Agora você usa o seguinte comando na sua pasta raiz do projeto para gerar a documentação.

doxx --source js --target docs --title "Exemplo"

Prontinho! Você terá uma pasta chamada docs no projeto com a documentação em HTML. Basta abrir o arquivo index.html no seu navegador. Há muitas outras opções e recomendo a leitura do site oficial.

Por hoje é só. Até a próxima.