Dox analisa código JavaScript, extrair comentários de código e montá-los em uma página de documentação criada usando Markdown e etiquetas JSDoc.
A página de documentação gerada está contida em um arquivo, sem JS externos ou arquivos CSS.
Dox vem como um fácil de usar executável, bem como um único arquivo de implantação.
Dox foi construído para ser utilizado a partir do Node.js única CLI
O que é novo nesta versão:.
- Adicionado:
- Suporte paradescription tag
- jogo Contexto para o fechamento retornou
- Etiquetas sem descrições agora têm uma propriedade HTML contendo uma análise de remarcação do conteúdo da tag
- Correções:
- Mais agnóstico ao estilo do código ao analisar contextos (por exemplo, não mais ignora funções sem espaços entre o nome da função e parênteses)
- No mais incorretamente tenta analisar strings dentro de comentários, causando grandes pedaços de um arquivo para ser ignorado.
- No longer analisa barra dupla em uma string literal como sendo um comentário começo.
O que é novo na versão 0.7.1:
- Adicionado:
- Suporte paradescription tag
- jogo Contexto para o fechamento retornou
- Etiquetas sem descrições agora têm uma propriedade HTML contendo uma análise de remarcação do conteúdo da tag
- Correções:
- Mais agnóstico ao estilo do código ao analisar contextos (por exemplo, não mais ignora funções sem espaços entre o nome da função e parênteses)
- No mais incorretamente tenta analisar strings dentro de comentários, causando grandes pedaços de um arquivo para ser ignorado.
- No longer analisa barra dupla em uma string literal como sendo um comentário começo.
O que é novo na versão 0.5.1:
- Arrumado:
- * / * breaks análise
O que é novo na versão 0.4.6:.
- Não enroleexample conteúdo com Markdown
O que é novo na versão 0.4.4:
- Adicionado suporte para nomes de variáveis contendo & quot; $ & quot ;.
O que é novo na versão 0.4.2:
- Prevent erro ao usar --api & comentários têm nenhum código de exemplo.
O que é novo na versão 0.4.1:
- Mudança # a. em --api.
O que é novo na versão 0.4.0:.
- blocos de código Adicionado gfm
- Removido títulos implícitos.
O que é novo na versão 0.3.3:.
- .receiver --api fixo
O que é novo na versão 0.3.1:.
- bug chato título fixo
O que é novo na versão 0.2.0:.
- Adicionado -r, suporte --raw
O que é novo na versão 0.1.3:
- Adicionado:. permitir que marcas arbitrárias
- whitespace função fixa.
O que é novo na versão 0.1.2:.
- HTML Removed escapar por enquanto
O que é novo na versão 0.1.1:
- Arrumado:
- Dois pontos em linhas de comentário não pretendido como cabeçalhos.
O que é novo na versão 0.0.5:
- A adição de & quot; & quot principal; para empacotar descritor desde & quot; diretórios & quot; não são mais suportados.
O que é novo na versão 0.0.4:
- Adicionado suporte para --intro incluindo um arquivo de introdução escrito em remarcação.
Requisitos :
- Node.js
Comentários não encontrado