Pessoal, segue uma parte da matéria direcionada as máximas de programação.
Esse material foi retirado do livro Algoritmos e estruturas de dados, Guimarães/Lajes, que temos na biblioteca.
Seguem as máximas de programação.
1- Algoritmos
devem ser feitos para serem lidos por seres humanos. Tenha em mente que seus
algoritmos deverão ser lidos e entendidos por outras pessoas ( e por você
mesmo) de tal forma que possam ser corrigidos, receber manutenção e ser
modificados.
2- Escreva
os comentários no momento em que estiver escrevendo o algoritmo. Um algoritmo
não documentado é um dos piores erros que um programador pode comenter e é
sinal de amadorismo ( mesmo com 10 anos de experiência). Como o objetivo de se
escrever comentários é facilitar o entendimento do algoritmo, eles devem ser
tão bem concebidos como o próprio algoritmo. E a melhor maneira de se conseguir
isso é escreve-lo nos momentos de maior intimidade com os detalhes, ou seja,
durante a resolução do problema.
3- Os
comentários deverão acrescentar alguma coisa, não apenas para frasear os
comandos. O conjunto de comandos nos diz o que esta sendo feito, os comentários
deverão nos dizer o por que.
4- Use
comentários no prologo. Todo algoritmo ou procedimento devera ter comentários
no seu prologo para explicar o que ele faz e fornecer instruções para o seu
uso. Alguns destes comentários seriam:
a. Uma
descrição do que faz o algoritmo;
b. Como
utiliza-lo;
c. Explicação
do significado das variáveis mais importantes;
d. Estruturas
de dados;
e. Os
nomes de quaisquer métodos especiais utilizados, juntamente com referencias nas
quais mais informações possam ser encontradas;
f.
Autor;
g. Data
da escrita.
5- Utilize
espaços em branco para melhorar a legibilidade. Espaços em branco, inclusive
linhas em branco, são valiosíssimos para melhorar a aparência do algoritmo.
6- Escolha
nomes representativos para suas variáveis. Os nomes das variáveis deverão
identificar, o melhor possível, as quantidades que elas representam. Por exemplo, X <- Y + Z é muito
menos que PREÇO <- CUSTO + LUCRO.
7- Um
comando por linha é suficiente. A utilização de vários comandos por linha é
prejudicial por varias razoes, dentre as quais se destacam:
a. O
algoritmo dica mais ilegível;
b. O
algoritmo fica mais difícil de ser depurado.
8- Utilize
parênteses para aumentar a legibilidade e prevenir-se contra erros.
9- Utilize
identação para mostrar a estrutura logica do algoritmo. A identação não deve
ser feita de forma caótica, mas segundo certos padrões estabelecidos.
10-
Lembre-se:
Toda vez que for feita uma modificação no algoritmo, os comentários associados
devem ser alterados, e não apenas os comandos. Antes não comentar, do que
deixar um comentário errado.