Já falei num artigo anterior sobre documentação de código fonte usando Doxx. O projeto foi descontinuado e seu sucessor se chama Mr. Doc. Vamos conhecer essa ferramenta.

Mr. Doc é uma refatoração de dox-foundation escrito em ES6, transformado para ES5 com Babel e é baseado no dox. Pode automaticamente gerar documentação elegante para código fonte com temas.

Por padrão, Mr. Doc usa o tema mr-doc-theme-default, baseado em Bootstrap e Prism.js para syntax highlighting.

Instalação:

npm install -g mr-doc

Para ver se está funcionando, use o comando:

mr-doc --help

Imagine o seguinte exemplo de código JavaScript:

/**
* 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.

mr-doc -s js/ -o docs/ -n "Meu Projeto"

A documentação do seu código estará na pasta docs. Para mais informações sobre como criar novos temas e usar outras opções do Mr. Doc, procure a documentação oficial.

Até a próxima.