Documentos naturais documentos naturais - gerador de documentação de código aberto, extensível e multi-linguagem
Baixe Agora

Documentos naturais Classificação e resumo

Documentos naturais Tag

gerar gerador gerar documentação Gerador de documentação. Geração de documentação documetation

Documentos naturais Descrição

Documentos Naturais - Gerador de documentação de código aberto, extensível e multi-linguagem Os documentos naturais são um gerador de documentação de várias fontes abertas, extensíveis e multi-linguões. Você só precisa documentar seu código em uma sintaxe natural que lê como inglês simples. Os documentos naturais varrearão seu código e criarão uma documentação de HTML de alta qualidade. quase transparente. Os comentários no código-fonte leram tão facilmente quanto a documentação gerada. Não há praticamente nenhuma tags encerrada. Vários idiomas: · Os documentos naturais suportam dezenove linguagens de programação fora da caixa, mesmo dentro do mesmo projeto. Suporta arquivos CGI e Extension, porque pode determinar sua linguagem por suas linhas de Shebang. Adicione seu próprio idioma: · Se a sua linguagem de programação ainda não estiver incluída com documentos naturais, você poderá adicionar suporte para ele apenas editando um arquivo de configuração. Mesmo a linguagem mais obscura pode ter um poderoso gerador de documentação. Toda ou apenas documentação explícita: · Dependendo do seu nível de suporte de idioma, você pode escolher entre ter documentos naturais documentam tudo ou apenas o que você documentou, o que o torna adequado para gerar referências de API. Palavras-chave flexíveis: · Os documentos naturais têm muitas palavras-chave para cada um dos seus tipos de tópicos para que você possa usar o que for mais natural para você. Você também pode personalizar os existentes ou adicionar seus próprios. Tópicos e índices personalizados: · Se você gostaria de documentar alguma faceta do seu código que os documentos naturais não sabem - talvez seja algo particular para o seu idioma ou projeto - você pode criar seu próprio tipo de tópico e palavras-chave para ele. Os documentos naturais até construirão seu próprio índice. Listas: · Os documentos naturais oferece uma sintaxe abreviada para documentar grandes grupos de itens pequenos, como constantes. Cada um se torna um símbolo vinculado como se tivesse seu próprio tópico. Gerada Documentação SaídaTattativa: · Ao contrário da documentação mais gerada, a saída dos documentos naturais parece profissional por padrão. Existem diferentes estilos para escolher, ou você pode fazer um sozinho. Estrutura poderosa CSS: · Documentos naturais tem uma estrutura de CSS poderosa e bem documentada que permite personalização completa. Embora os estilos padrão nem sempre mostrem, você pode fazer coisas como ter links para funções ser um estilo e links para as classes serem outro. Você pode até ter estilos específicos do navegador em um único arquivo CSS para trabalhar em torno de quirks de renderização. Endereços de e-mail transparentemente comungados: · Endereços de e-mail que aparecem na opinião de documentação e agem como links de e-mail regulares, mas eles são transparentemente comuns para evitar rastreadores de spam. Dicas de ferramentas em todos os lugares: · Cada link para cada tópico documentado tem seu resumo como uma dica de ferramenta. Links para funções e variáveis têm seus protoypes totalmente formatados nas dicas de ferramentas também. HTML emoldurado ou não-reproduz: · É a sua documentação, por isso é a sua escolha. Você pode manter todas as páginas independentes e facilmente ligadas ou manter o menu em um quadro separado para facilitar a navegação. Ignorar prefixos no índice: · Prefixos comuns não precisam arruinar seus índices. Se todas as suas aulas começarem com C, ou se você tiver um monte de funções que começam com com_, você pode ter documentos naturais ignorá-los de modo que CCAT, Cdog e cmouse apareçam em C, D, e m em vez de todos sob C. Program Altamente automatizado: · Documentos naturais detecta quais partes da sua árvore de origem alteram e ajustarão a documentação de acordo. Será automaticamente manter e organizar o menu se você não fizer isso sozinho. Ele reconstruirá automaticamente a documentação se alterações de linha de comando ou configuração precisarem. Processo de construção diferencial: · Os documentos naturais constroem apenas os arquivos que foram alterados ou adicionados desde a última execução e os arquivos que dependem deles, reduzindo drasticamente o tempo de execução e tornando-o adequado para projetos maiores. Arquitetura extensível: · Os documentos naturais são projetados para serem facilmente estendidos para diferentes linguagens de programação, tópicos e estilos CSS, todos documentados neste site. Arquivos de configuração inteligente: · Documentos naturais detecta alterações feitas nos arquivos de configuração e lidarão com os detalhes menores. Eles automaticamente reformam para que você possa fazer edições rápidas e sujas e ainda manter a legibilidade. Arquivos de configuração do projeto mantêm uma lista atualizada das coisas definidas nos arquivos principais para que você saiba o que você pode substituir sem consultá-los. Portátil: · Os documentos naturais funcionam em qualquer lugar que Perl é executado, e isso é bastante lugares. Livre e aberto: · Os documentos naturais são licenciados sob a GPL, então não há nenhum custo e você pode mexer com a fonte para a delícia do seu coração.

Documentos naturais Software Relacionado