O código não tem dono

Uma das percepções que vem com o tempo é a de que os códigos, sem dúvida, não têm dono. Mais cedo ou mais tarde alguém diferente de você vai ter que mexer no seu código e esse alguém pode ser realmente outra pessoa ou você mesmo numa fase diferente da sua vida. Tanto numa opção quanto em outra você colhe o que planta: se fez um código com o mínimo de decência tudo flui bem, caso contrário instaura-se o caos (e, com absoluta certeza, você vai ser xingado – por outra pessoa ou por você mesmo).

Um dos fatores decisivos nessa limpeza do código é a escolha dos nomes. Nomes de variáveis, ids, classes, tudo deve ser bem pensado, mas é na escolha dos nomes no HTML que este post vai focar mais intensamente.

Bons nomes refletem o que os elementos são e não o que eles estão. Um bom exemplo é o nome de ids de menus. Supondo que o site tem dois menus: um auxiliar, localizado no topo, e um à esquerda, com mais importância, os melhores nomes são “menu-auxiliar” e “menu-principal” e não “menu-topo” e “menu-esquerda”, uma vez que o que está na esquerda hoje pode ir para outro lugar amanhã com alguma mínima mudança de CSS. Se isso acontecer e o nome não refletir o que o elemento é de fato o nome “menu-esquerda” ficará um pouco sem sentido. É fácil imaginar (já vi acontecendo muitas vezes…) alguém achando estranho uma lista com id “menu-esquerda” estar na direita.

Idem para destaques com nome relacionado à figura de fundo (o nome da classe “sacolinha” não foi o melhor para um destaque que depois virou um globo terrestre).

Outro ponto importante é a escolha do idioma que vai ser adotado. Coerência é importante para que o próximo a mexer no seu código não se perca. Infelizmente é comum termos nomes de figura “bg-header” e “bg-rodape” no mesmo site. Utilize inglês ou português (prefiro o português por não saber quem vai mexer naquele código depois de mim), os dois juntos fica confuso e parece que você não domina os idiomas.

Abraços e até o próximo post!


Não quer perder o próximo post? Cadastre seu e-mail e você receberá um aviso sempre que sair coisa nova :)

Comentários