Programador Feirense

Carreira, Tecnologia e Programação

Mr. Doc

Conheça o Mr. Doc

20 de abril de 2020 Software Livre Tutoriais No Comments

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.

JavaDocJavaScriptMr. Doc

Ganhe dinheiro na internet: Google Opinion Rewards

Ubuntu 20.04 está entre nós

Deixe uma resposta Cancelar resposta

Time limit is exhausted. Please reload CAPTCHA.

Esse site utiliza o Akismet para reduzir spam. Aprenda como seus dados de comentários são processados.

Pesquisa


Siga nas redes sociais

Blogorama - The Blog Directory

Small Acts Manifesto

Posts recentes

  • Review: Acer Chromebook C733
  • Eu não sou seu guru!
  • Ubuntu 20.10 está entre nós
  • Raspando a web com Java: parte 5
  • Raspando a web com Java: parte 4

Arquivos

  • dezembro 2020
  • outubro 2020
  • agosto 2020
  • julho 2020
  • junho 2020
  • maio 2020
  • abril 2020
  • março 2020
  • fevereiro 2020
  • janeiro 2020
  • dezembro 2019
  • outubro 2019
  • setembro 2019
  • junho 2019
  • maio 2019
  • abril 2019
  • março 2019
  • fevereiro 2019
  • janeiro 2019
  • dezembro 2018
  • setembro 2018
  • agosto 2018
  • julho 2018
  • junho 2018
  • maio 2018
  • abril 2018
  • março 2018
  • fevereiro 2018
  • janeiro 2018
  • dezembro 2017
  • novembro 2017
  • outubro 2017
  • setembro 2017
  • agosto 2017
  • julho 2017
  • junho 2017
  • maio 2017
  • abril 2017
  • março 2017
  • fevereiro 2017
  • janeiro 2017
  • dezembro 2016
  • novembro 2016
  • outubro 2016
  • setembro 2016
  • agosto 2016
  • julho 2016
  • junho 2016
  • maio 2016
  • abril 2016
  • março 2016
  • fevereiro 2016
  • janeiro 2016
  • dezembro 2015
  • novembro 2015
  • outubro 2015
  • setembro 2015
  • agosto 2015
  • julho 2015
  • junho 2015
  • maio 2015
  • abril 2015
  • março 2015
  • fevereiro 2015
  • janeiro 2015
  • dezembro 2014
  • novembro 2014
  • outubro 2014
  • setembro 2014
  • agosto 2014
  • junho 2014
  • abril 2014
  • março 2014
  • fevereiro 2014
  • janeiro 2014
  • dezembro 2013
  • novembro 2013
  • outubro 2013
  • agosto 2013
  • julho 2013
  • junho 2013
  • maio 2013
  • abril 2013
  • março 2013
  • fevereiro 2013
  • janeiro 2013
  • dezembro 2012
  • novembro 2012
  • outubro 2012
  • agosto 2011
  • junho 2011
  • maio 2011
  • abril 2011
  • março 2011
Proudly powered by WordPress | Theme: Doo by ThemeVS.