Markdown: Escreva para a Web
Simples. Legível. Gravável. Markdown é a abstração mais pura de HTML que existe. É uma linguagem direta com sua própria sintaxe, fácil de entender e usar. Markdown foi inventado em …
Continuar lendoEtiqueta: documentation
Documentação da API REST – Uma primeira diretriz
Se você desenvolve uma API, especialmente uma API REST, deve garantir que ela seja bem documentada. Não existe uma maneira aceita exclusivamente de formalizar serviços RESTful. Mesmo assim, você deseja …
Continuar lendoEscrevendo documentação
Lembre-se de que o leitor da documentação não está tão familiarizado com o código quanto você e provavelmente não se preocupa com a beleza intrínseca de seus adoráveis algoritmos. O …
Continuar lendojsig – notação de assinatura JavaScript precisa e concisa
Claro, JavaScript é uma linguagem tipada dinamicamente, mas descobri que ter uma notação explícita é a maneira mais rápida de comunicar a outro desenvolvedor como usar um módulo que escrevi. …
Continuar lendoPHP Reflection é seu amigo
Reflexão / introspecção é aquilo de que você não precisa até fazer. E quando o faz, geralmente esquece que está lá. Em suma, a reflexão permite que você olhe para …
Continuar lendoCertifique-se de que os exemplos de código funcionem imediatamente!
TL; DR poucas coisas ensinam as pessoas melhor do que exemplos de código de trabalho. teste-os automaticamente! Qual é o problema? Ao adquirir uma nova biblioteca, muitas pessoas começam lendo …
Continuar lendoO padrão wiki-as-submodule
A documentação do usuário para o seu projeto de software é importante. Mas, além de demorar para ser escrito, dois pontos principais tornam difícil ter um bom manual: Você nunca …
Continuar lendoComo comentar o código
Com muita frequência, vejo código mal comentado. Aqui estão algumas diretrizes que tento seguir para comentários: Descreva apenas como quando complicado Sempre descreva o que Faça isso no nível de …
Continuar lendoAlvo Appledoc Xcode
Instale o appledoc: brew install appledoc Acesse Projeto> Adicionar “Documentação” de destino e, em seguida, fases de compilação> Adicionar fase de compilação> Adicionar script de execução /usr/local/bin/appledoc –project-name “MyProject” –project-company …
Continuar lendoSempre leia a documentação com atenção
Acontece que eu bati em uma parede quando não li a documentação cuidadosamente para usar push heap e pop heap da biblioteca C ++ STL. Em poucas palavras vector<T> myHeap;myHeap.push_back(T);push_heap(myHeap.begin(), …
Continuar lendoQuer pesquisar os documentos do React? Faça isso com Dash!
Os documentos do React não têm uma função essencial: pesquisar. A comunidade percebeu e há até mesmo um problema no Github em que um provedor de pesquisa SaaS proeminente Algolia …
Continuar lendoUm caso para documentação ao aprender a codificar
A documentação pode economizar muito tempo ao trabalhar com grupos, pois ajuda os membros a entender a lógica de um programa sem a necessidade de percorrê-la. Também pode ser muito …
Continuar lendoPágina de manual específica para comandos integrados `bash`
Talvez você já tenha a frustração de cair em uma manpágina genérica após digitar $ man builtin_command onde builtin_commandestá um bashcomando embutido como readou alias. Como eu percebi há alguns …
Continuar lendoSublime Text 2 javascript docstring snippet
Eu me peguei constantemente escrevendo documentação para funções javascript e fazendo um bloco de comentários bonito sempre perdia meu tempo. Salve este trecho como um arquivo que termina com uma …
Continuar lendoapi documentation / documentation / documenting / docutils / markdown / markup / python / rest / restructuredtext / sphinx
Qual é a diferença: reST, docutils, sphinx, readthedocs
Isso mudou para: https://www.git-pull.com/code_explorer/rst-docutils-sphinx-readthedocs.html (editado em 2020-06-05, link fixo) Code Explorer: Viagem através de reST, docutils, sphinx e extensões. Para aqueles que projetam temas baseados em reStructuredText, docutils, sphinx ou …
Continuar lendoReconstruir documentos do sphinx quando um arquivo de origem é modificado
Ao escrever documentação usando o Sphinx, fica muito chato ter que executar manualmente make htmltoda vez que você faz uma alteração em um arquivo de origem para ver o resultado …
Continuar lendo