1. Nomear coerentemente as variáveisPode parecer o mais batido de todos, mas é um dos menos seguidos; as variáveis temporárias geralmente tem os piores nomes possíveis, pois ou são muito compridos ou então muito genéricos; nomear essas variáveis é uma arte. Vale lembrar que usar as mesmas variáveis temporárias pode melhorar o desempenho, mas deixa o código menos legível, então deve-se analisar o que é melhor em dado caso. Pode-se colocar um indicativo do tipo de variável em linguagens fortemente
tipadas, por exemplo, o inteiro ponto poderia ser
iPonto, e se fosse um
float poderia ser
fPonto.
2. Identar o códigoA
identação de um código pode ser feita com espaços em branco ou com
tabs; a grande maioria dos programadores preferem com
tabs, portanto tente sempre usá-las. Algumas aplicações
transformam todos os seus
tabs em espaço em branco, como o
Dev-C++; evite usá-las. Uma das grandes vantagens de se usar
tabs é que cada programador pode gostar de diferentes
níveis de
identação, isso é, com mais ou menos espaços, e boa parte das ferramentas de programação permitem você decidir quantos espaços você quer ver no lugar de um
TAB, dando mais flexibilidade para a visualização do código. Quanto menos níveis de
identação tem um programa, mais ele se torna legível; veja a próxima dica
3. Module o seu códigoUma grande invenção na programação foram as
subrotinas, então use-as! Elas servem para muitas coisas, como para a
abstração de partes do código irrelevantes para o programador em dado momento. Por exemplo, se o seu programa abre um arquivo para pegar os dados, aplica uma função e retorna um resultado, e o
objetivo do programador é modificar a função, pode ser interessante apenas assumir que os dados já foram
pegos posteriormente, sem se importar como eles foram
pegos; Se for necessário saber o formato em que os dados são retornados, deve-se olhar a documentação da função (que deve existir, olhe a dica 5). Outra grande utilidade das
subrotinas é a capacidade de tirar vários níveis de
identação, pois na
subrotina a
identação começa novamente do primeiro
nível.
4. Use constantesMuito importante para a portabilidade e o
possível reaproveitamento do código que muitos programadores
simplesmente esquecem. Declarar constantes o bastante pode magicamente poupar uma tarde de trabalho e vários
ctrl+f em um código. Note que constantes do tipo
TRES para o numero 3 são inúteis, já constantes do tipo NUM_
THREADS para um programa multi
thread é muito útil.
5. Comente e documenteQuanto maior/mais complexo for ficando o código, maior deve ser o cuidado com a documentação. Ela ajuda a relembrar como foi programado, a entender o que uma determinada função faz, ou ainda onde se muda algumas constantes do programa. Um exemplo negativo dessa vez: quando não temos uma documentação de como os dados são tratados por certa função, o único modo de descobrir é olhando o código da função, trabalho que pode levar muito tempo e que poderia ser resumido a 5 minutos, lendo um parágrafo de documentação. Acredite, mesmo que seja você quem tenha escrito a função, pode acabar esquecendo como formatou dos dados.