Resultados da pesquisa a pedido "documentation"
Não mostrar blocos declaradores com p6doc
Escrevi um pequeno arquivo de exemplo para aprender mais sobre o Perl 6 POD e estou usandop6doc para renderizar uma pequena página de manual do documento POD. Contudo,p6doc também tenta analisar os blocos declaradores fora do documento POD. Isso ...
Como uso caracteres Unicode no Pod e no perldoc?
Eu preciso usar caracteres utf-8 na minha documentação perl. Se eu usar: perldoc MyMod.pmEu vejo personagens estranhos. Se eu usar: pod2text MyMod.pmtudo está bem. Eu uso o Ubuntu / Debian. $ locale LANG=de_DE.UTF-8 LC_CTYPE="de_DE.UTF-8" ...
Posso suprimir a expansão variável na documentação do Sphinx?
No meu código eu tenho X_DEFAULT = ['a', 'long', 'list', 'of', 'values', 'that', 'is', 'really', 'ugly', 'to', 'see', 'over', 'and', 'over', 'again', 'every', 'time', 'it', 'is', 'referred', 'to', 'in', 'the', 'documentation']e depois def ...
Quais etapas são necessárias para documentar o `package main` no Godoc?
Godoc é uma ótima ferramenta para documentar pacotes, no entanto, parece ser menos útil quando usado contrapackage main. Vou ver uma saída que exibe apenas as notas que escrevi para mim mesmo usando//BUG e subdiretórios. Godoc apenas exibe ...
Documentação de teste de unidade [fechada]
Eu gostaria de saber daqueles que documentam os testes de unidade como eles estão documentando. Entendo que a maioria dos seguidores do TDD afirma que "o código fala" e, portanto, a documentação de teste não é muito importante porque o código ...
Como ver documentos e outras informações de símbolos no Common Lisp REPL?
Sou completamente novo no CL e gostaria de aprender a ler cadeias de documentação e obter outras informações de ajuda no REPL. Algo comohelp(symbol) em Python ousymbol? no iPython, ou:t e:i no GHCi de Haskell. Então, com o nome de um símbolo, eu ...
Doxygen vs Javadoc [fechado]
Acabei de perceber em um artigo no CACM que o Doxygen também trabalha com Java (e várias outras linguagens). Mas o Java já possui a ferramenta Javadoc. Alguém pode explicar quais são os prós e os contras de qualquer uma das abordagens? Eles são ...
Como fazer funcionar os comentários completos da dica de ferramenta intellisense?
Eu tenho algum software C ++ / CLI que é legal e documentado de uma maneira C # 'ish, o que significa que o DOxygen é capaz de extraí-lo para um bom html. Existe alguma maneira de conseguir que essas mesmas informações apareçam nas dicas da ...
Documente HAL “_links” de Spring Hateoas (com arrogância)? [fechadas]
Eu tenho um serviço REST que quero documentar para minha equipe de desenvolvimento de clientes. Então eu adicionei algunsLinks deSpring-Hateoas à minha API de recursos e conectado a elaswagger-springmvc @Api... anotações para documentar tudo e ...