DocumentJS funciona através da linha de comando Node.js e permite que desenvolvedores criem sites de documentação sem ter que fazer uma dupla tarefa de escrever comentários no seu código e, em seguida, explicando-lo mais tarde em um arquivo HTML separado.
O site de documentação é criado usando o código-fonte comenta-se, todos automaticamente se os desenvolvedores sigam comentários de código simples regras de formatação.
DocumentJS suporta estruturas simples e sintaxe Markdown, juntamente com a capacidade de criar documentação versão, trabalhando em sincronia com a história de controle de versão do código.
No caso de o código comenta ocupar muito espaço em sua origem, eles podem ser exportados para um arquivo Markdown separada e, em seguida, amarrado de volta para o código original utilizando marcadores simples.
Esta última característica funciona muito bem para projetos maiores, onde mais de uma pessoa trabalha no código e mais detalhes em profundidade são necessários para cada função, método ou parâmetro.
.
DocumentJS & nbsp; foi desenvolvido para ser parte do framework JavaScript - JavaScriptMVC
Características :
- organização flexível de sua documentação
- Um visualizador de documentação integrado onde você pode pesquisar a sua API
- suporte Markdown
- Uma arquitetura extensível
Comentários não encontrado