Escrevendo bons programas
A utilização correta das funções, métodos e classes é um dos sinais distintivos de um programador experiente. Aqui estão alguns conselhos importantes.
Funções e métodos - pequena e bonita.
Uma função ou um método deve fazer uma coisa e fazê-lo bem.
- Se você não puder resumir em uma frase o que a função faz, talvez ela seja muito complicada.
- Se você tiver a rolar para ver toda a função, talvez ela seja muito longa.
- Estudos sugerem que uma pessoa só pode manter o controle de, no máximo, 7 coisas de uma só vez. Se a sua função tem mais de 5 ou 6 variáveis, provavelmente é muito longa.
Comentários
Ao escrever programas mais complexos, o uso de comentários torna-se mais importante.
1- Comentários não devem ser longos. Devem somente explicar claramente o propósito do código.
2- Cada função deve ter um comentário que afirma o que a função faz. A exceção seria uma função que é tão simples que é usar é óbvia. Por exemplo:
- Os métodos initialize, add e remove não
precisam de comentários.
- Em AddresBook, os métodos each e each_address
possuem somente um simples comentário. O comentário diz que eles
são iteradores. Uma vez que o desenvolvedor sabe que elas são
iteradores, a sua utilização torna-se evidente a partir de seus
nomes.
- O método by_name tem um comentário dizendo que é
uma função de classificação. Uma vez que você
sabe o que é, seu uso também é aparente.
- Comentários também podem ser usados para agrupar funções
relacionadas. Por exemplo, em AddressBook usei comentários para
agrupar "funções fundamentais", "iteradores"
e "funções de classificação ".
3- Sempre tente dividir seu código em peças manuseáveis.
