Um trecho sem contexto vira um exercício de adivinhação. Você pode lembrar por que o salvou hoje, mas seis meses depois a entrada, dependência ou suposição ausente pode importar mais que o próprio código.

Salve o problema junto da solução

Dê à nota um título descritivo e explique o que o trecho faz. Registre a linguagem, a versão relevante e as dependências. Inclua o menor exemplo de entrada e a saída que esperava quando o testou.

Se o trecho veio de uma fonte, guarde o link e confira os termos de reutilização. Não remova a atribuição só porque o fragmento é curto. Mantenha segredos, dados reais de clientes e credenciais específicas do ambiente fora do exemplo salvo.

Explique os pressupostos

Declare quais entradas o código aceita e quais não aceita. Anote se altera arquivos, chama um serviço ou exige permissões. Um comando que parece um atalho conveniente pode ter um efeito muito diferente em outro diretório.

Use um bloco de código delimitado com indicação de linguagem quando seu renderizador Markdown aceitar. O editor de projetos do MeatPad pode manter a nota ao lado dos arquivos de código relacionados. O destaque de sintaxe ajuda a leitura; não estabelece que o trecho esteja correto.

Confira de novo antes de reutilizar

Execute o trecho em um pequeno exemplo sem importância no ambiente em que pretende usá-lo. Compare o resultado com a expectativa salva. Dependências e APIs podem mudar depois que a nota foi escrita.

Adicione uma data de última verificação quando o fragmento fizer parte de um fluxo recorrente. Se seu contexto cresceu até virar um programa inteiro, transforme-o em um script mantido em vez de acumular correções em uma nota. O trecho útil é aquele que você consegue explicar e testar, não apenas colar.

Fontes e detalhes do produto

Comece com uma nota. O MeatPad dá às notas, ao Markdown e aos arquivos de projeto uma área de trabalho local no seu Mac, sem exigir uma conta.

Explorar MeatPad →