Luis Araujo
sobre

Para quem não sabe o JSDoc é uma API para documentação de projetos javascripts. Basicamente ela funciona obtendo dados dos comentários, assim como JavaDoc. Para isso é preciso usar algumas tags (@) especificadas na documentação da API. Você pode consultar a documentação em: usejsdoc.org. Nesse post vamos mostrar como instalar e rodá-la no windows.

Pré-requisito para o JSDoc

Você precisa instalar o Node.js para intalar o JSDoc.

Instalando o JSDoc

Com o Node instalado, vá no console e instale o jsdoc com o seguinte comando:

npm install -g jsdoc

Pronto, você já possui o jsdoc. Como esse instalação é global, você só precisa usar o comando jsdoc para rodar. Vá até a pasta do seu projeto e execute o comando juntamente com o nome do arquivo:

jsdoc myfile.js

Ele irá criar uma pasta chamada "out" [essa pasta pode ser configurada com jsdoc -d] com a documentação em html.

Há!!! Você pode colocar mais arquivos utilizando espaço:

jsdoc myfile.js myfile2.js
E também ter arquivos em outra pasta
jsdoc myfile.js Teste/myfile2.js
Qualquer dúvida manda entra em contato!