TT-103 Linguagem e Tcnicas de Programao I

boas prticas

Objetivo Indicar quais seriam as boas prticas de programao, ressaltando os vcios normalmente encontrados em C. 1- Comente adequadamente No incio de cada arquivo deve ter seu nome, uma descrio do que o arquivo contm, quem o criou e em qual data. Antes de cada rotina, deve ser explicado o que ela faz, o que ela retorna e qual o comportamento das variveis. Use como premissa que algum consegue definir se ir ou no usar a rotina e poder us-la apenas lendo o comentrio, sem precisar conhecer o cdigo. O uso de linhas com * ou algum outro caracter ajuda a facilitar a identificao das rotinas no meio do cdigo. Se a rotina ficar grande, importante explicar na criao das variveis o que elas fazem. Comente cada grande parte do cdigo. Por exemplo, quando o programa entra em um if e quando entra em um else. Mas no precisa comentar coisas bvias como explicar que contador++ est incrementando o contador. 2- D nomes claros s variveis Uma varivel no precisa ter nome e sobrenome, mas no deve ser chamada apenas por uma letra. Seu nome deve ter um significado lgico, de forma que algum apenas lendo o nome consiga imaginar o que deve ser armazenado na varivel. So exemplos de nomes inadequados: i, j, aux. 3- Declarao e inicializao de variveis separadas da lgica Tenha como prtica declarar todas as variveis que um programa ir utilizar logo aps o ttulo da rotina. Desta forma fica muito mais simples para quem ir fazer a manuteno do cdigo entend-lo. Depois das declaraes e antes da lgica as variveis devem ser inicializadas. No faa as coisas todas juntas, pois o cdigo perde em clareza. 4- Use comandos claros e usualmente conhecidos C tem um monte de comandos esdrxulos e/ou exticos. Legal que voc os descubra como hobby. Mas us-los no faz o menor sentido, salvo quando no haja um comando tradicional que faa o mesmo. Lembre-se que seu programa poder ter que ser corrigido por algum que nunca programou em C at o momento e nem tem a obrigao de conhecer todos os detalhes da linguagem.

5- Idente algo simples e que facilita incrivelmente tanto a construo de um programa como sua manuteno. Use, se possvel, o prprio tab ao invs de espaos, para que seja fcil manter todas as linhas iniciando-se na mesma coluna. Deixe os { e } sempre em linhas independentes, para que seja fcil identificar-se tudo que est entre os dois. 6- No economize {} Mesmo que seja apenas um comando, uma boa prtica colocar {}. Muitas vezes, em um momento de nervosismo, quando por exemplo um cliente est com a fbrica parada por um erro no cdigo, as pessoas incluem um comando a mais em um else, por exemplo, e se esquecem de checar se tem os { e } correspondentes. Se no houver, o comando ficar em lugar errado e o erro continuar ocorrendo. 7- Programe estruturadamente C no , per se, uma linguagem estruturada. Quem faz ela estruturada quem programa. Assim, no use em hiptese alguma: - goto e labels - returns no meio de rotinas. Cada rotina deve ter apenas um nico return, em sua ltima linha. - breaks no meio de loops. Deve-se sair de um loop apenas com base nas regras lgicas do loop. No devem existir tambm segmentos de cdigo iguais em vrias partes do programa. Se isso acontecer, avalie como criar uma rotina e cham-la nessas vrias posies do cdigo. Tambm deve ser evitado ao mximo o uso de variveis globais. 8- Divida as rotinas de forma adequada Uma rotina que no cabe em uma tela no uma rotina interessante. Lgico que em certos casos no ter-se- como fazer diferente. Mas o ideal sempre buscar-se construir rotinas pequenas. 9- Use tipagem forte logicamente C uma linguagem fracamente tipada. Ou seja, ele no checa se voc est usando corretamente os tipos da linguagem. Voc pode inserir um caracter em uma varivel numrica, por exemplo. Pode, mas no deve! (salvo em rarssimas excees onde isso precisar ser feito). Tome o cuidado de usar variveis do tipo correspondente ao seu uso. 10- Programe para outros e no para voc Lembre-se que na vida real no ser voc que ir corrigir o seu programa. Assim, voc deve sempre programar de forma simples e clara, de forma que qualquer pessoa que precise alter-lo o faa facilmente. Se voc pensar que um programa confuso pode garantir seu emprego, provavelmente voc vai perder mais rapidamente seu emprego e muito dificilmente conseguir recomendao para outro, dada a pouca qualidade do seu trabalho. Lembre-se que voc tambm precisar corrigir programas dos outros. Garanto que se os outros no seguirem as regras acima, voc vai entender claramente porque elas so to importantes!