Escrevendo Código Reciclável

A grande maioria do código que escrevemos destina-se a servir a um único propósito e, uma vez empregado nesse propósito, nunca mais verá a luz do dia. Isso é, no entanto, um desperdício de seu valioso tempo, quando é perfeitamente possível escrever seu código de forma que ele possa ser reciclado e colocado em uso em muitas finalidades diferentes.

O desafio é que escrever código reciclável é bem diferente de escrever o que pode ser chamado de código “descartável”. Com o último tipo de código, você realmente só precisa se preocupar com o modo como os outros humanos interpretam suas instruções de código, se você não tiver escrito essas instruções perfeitamente. Quando você escreve código reciclável, no entanto, você precisa fazê-lo de uma maneira muito específica, e você realmente precisa pensar em como alguém, inclusive você, entenderá o código que você escreveu em algum momento no futuro.

Fazer as coisas dessa maneira leva muito mais tempo e esforço do que a codificação comum, mas tem a vantagem de nunca precisar escrever a mesma função duas vezes. Como dito, você precisará fazer tudo de uma certa maneira para ter certeza de que seu código realmente pode ser usado novamente para outros propósitos.

Vale ressaltar que o código reciclável não é necessariamente a mesma coisa que um plug-in. Quando você cria um plug-in, você está desenvolvendo algum código que qualquer um pode tomar e incorporar em seu site e gerar facilmente algum efeito a partir dele apenas alterando alguns parâmetros.

O código reciclável é diferente no sentido de que não é necessariamente estático e não é necessariamente destinado a distribuição fora de sua própria organização. Não importa o quê, é essencial certificar-se de usar o processo correto, descrito abaixo.

1. Torne-se um mestre da organização

Quando você cria um código com a intenção de reutilizá-lo mais tarde, isso não ajudará muito se você não conseguir encontrá-lo. Você precisa fazer um ótimo trabalho ao nomear, armazenar e classificar seus arquivos de código.

2. Esteja ciente do que é "aplicativo específico" e o que é "genérico"

Quase sempre haverá algum código que é realmente específico para o seu aplicativo em particular e não poderia ser usado de qualquer outra forma. Ao criar cada parte do código, você deve decidir se é um código genérico ou específico do aplicativo. Em última análise, você quer criar muito mais do que o anterior, e há uma boa maneira de fazer isso que eu vou descrever no passo 3.

3. Código separado dos valores

Valores de variáveis ​​codificados podem apresentar um problema quando você deseja usar o código de novas maneiras. Uma maneira melhor de fazer isso é armazenar seus valores de variáveis ​​iniciais em algo como um arquivo CSV e, em seguida, carregar esses valores quando o aplicativo for iniciado. Esse método também permite que você altere facilmente os valores das variáveis ​​iniciais sem adulterar o arquivo de código original.

4. Tente não codificar todos os valores que não precisam ser absolutamente

Isso basicamente significa que você não deve codificar quaisquer valores, com uma exceção, que é o nome do arquivo que será carregado contendo todos os valores codificados. Esse arquivo deve estar sempre acessível em relação ao caminho raiz do aplicativo ou você pode ter problemas se mover os arquivos para um sistema operacional diferente.

5. Evite colocar espaços em nomes de arquivos

Só porque você pode colocar espaços em nomes de arquivos não significa que você deveria. Ele pode criar problemas para você, se você mover seus arquivos para um sistema operacional ou sistema de arquivos diferente. Por exemplo, se você mover seus arquivos do ext4 para o FAT, poderá encontrar problemas. Curiosamente, o sistema operacional Windows exibirá os nomes dos arquivos com caracteres ilegais, mas não permitirá acesso a esses arquivos, mesmo que tudo o que você queira fazer seja renomeá-los.

5. Comente tudo detalhadamente

No momento em que você escreve seu código, você sabe exatamente o que vai fazer. Mas permita que alguns anos se passem e é bem possível que você tenha esquecido suas intenções. É a mesma história também quando você está usando o código de outra pessoa, porque a menos que eles tenham fornecido comentários detalhados, você terá que gastar preciosos momentos analisando e interpretando o que eles escreveram.

6. Evite criar dependências

Uma das maiores falhas nos cenários de código mais reutilizáveis ​​é que você pode acabar com enormes cadeias de dependências de arquivos. Isso acontece porque as pessoas escrevem seus códigos de forma específica e os incluem em uma ordem específica sem documentar o motivo. Então, antes que você perceba, você acaba com um cenário do Left-Pad e todo mundo entra em pânico quando algum pedaço de código do qual seu aplicativo está dependendo fica com o AWOL por algum motivo.

Você pode evitar esse tipo de fusão, certificando-se de que cada pedaço de código pode ser facilmente trocado por outro, documentando como um louco, e, claro, fazer cópias de backup de cada pedaço.

A documentação deve incluir o que é um arquivo, o que faz e por que ele é carregado no local específico em que é carregado. Isso elimina possíveis problemas de dependência, porque qualquer parte do código pode ser recriada porque sua finalidade é conhecida.

7. Formate todo o seu código de maneira muito precisa

Obviamente, é uma boa ideia sempre fazer isso de qualquer maneira, mas é especialmente importante fazer isso quando você está escrevendo um código reutilizável. Você também deve manter um estilo muito consistente de codificação e não alterá-lo. Por exemplo, se você tende a escrever seus nomes constantes em nomes de letras maiúsculas e variáveis ​​no camelCase, você deve fazer isso com consistência absoluta.

8. Cada pedaço de código tem um propósito específico

Sua missão é entender qual é esse propósito. Você deve evitar vários propósitos por trecho. Por exemplo, se você tem um pedaço de código que carrega nos valores iniciais da variável, não deve fazer mais nada além disso. Seu próximo pedaço de código deve estar lidando com a próxima operação necessária. Quão estrita é essa regra? Bem, sua função principal não deve fazer nada além de fazer chamadas para todas as outras funções.

É muito mais difícil escrever um bom bem reciclável do que qualquer um pensaria antes de tentar. Não importa quais sejam suas intenções iniciais, é provável que você descubra que cerca de 80% do código que você escreve acabarão sendo específicos do aplicativo em vez de genéricos. A maioria das pessoas elogia o código reciclável sem realmente ter qualquer ideia de como ele realmente o usará no futuro, com o resultado final sendo que eles criam mais trabalho para eles mesmos, o que é o oposto do objetivo. Espero que este artigo tenha ajudado você a evitar esse destino.

imagem de cabeçalho cortesia de DKNG

Bogdan Rancea

Bogdan é um membro fundador da Inspired Mag, acumulando quase 6 anos de experiência neste período. Em seu tempo livre, ele gosta de estudar música clássica e explorar artes visuais. Ele é muito obcecado com fixies também. Ele é dono do 5 já.