Legibilidade do código fonte

Transcrição

1 Sumário Legibilidade do código fonte Exemplos Normas Instrução switch Sintaxe e Semântica Exemplo Tipos enumerados Exemplo Programação 2007/2008 DEEC-IST 1 Legibilidade do código fonte Exemplo: Considere que é necessário desenvolver um programa para gerar um calendário, por exemplo que produza o mesmo resultado que o comando cal do linux. Suponha que o utilizador especifica o ano, se normal ou bissexto o mês o dia da semana em que ocorre o primeiro dia do mês O programa deve então produzir uma tabela com o formato seguinte: Ano (0- Normal 1-Bissexto) = 0 Mes (1-Jan,..., 12-Dez) = 10 Dia da Semana (1-Dom,2-Seg...., 7-Sab.) = 3 Dom Seg Ter Qua Qui Sex Sab Programação 2007/2008 DEEC-IST 2

2 Legibilidade do código fonte Na resolução do problema anterior serão apresentadas diversas soluções: 1ª Solução: Os nomes das variáveis não reflectem o contexto em que são utilizadas Os dados de entrada não são validados O código não está alinhado 2ª Solução: Os nomes das variáveis são adequados Os dados de entrada são validados O código está alinhado Qual das soluções é mais fácil de compreender? Qual das soluções apresenta menos erros de execução? Programação 2007/2008 DEEC-IST 3 Legibilidade do código fonte /* 1ª solução para o problema do calendário*/ #include <stdio.h> int main (void) { int a, m, ds; int ddm; int ma; int i, j; printf("\n Ano (0- Normal 1-Bissexto) = "); scanf("%d", &a); printf(" Mes (1-Jan,..., 12-Dez) = "); scanf("%d", &m); printf(" Dia da Semana (1-Dom,2-Seg...., 7-Sab.) = "); scanf("%d", &ds); if ((m == 1) (m == 3) (m == 5) (m == 7) (m == 8) (m == 10) (m ==12)) ddm = 31; if ((m == 4) (m == 6) (m == 9) (m == 11)) ddm = 30; if (m == 2) if (a == 0) ddm = 28; else ddm = 29; printf("\n\n Dom Seg Ter Qua Qui Sex Sab\n"); /* Apresenta o quadrado */ for (i=1; i<ds; ++i) printf(" "); ma = ds; for (j=1; j<=ddm; ++j) { printf(" %3d", j); if (ma == 7) { printf("\n"); ma = 0; ma = ma + 1; return (0); Programação 2007/2008 DEEC-IST 4

3 Legibilidade do código fonte /* 2ª solução para o problema do calendário*/ #define FIM_LINHA 7 #include <stdio.h> int main (void) { int ano, mes, dia_semana; int dias_do_mes; int muda; /* var. utilizada na apresentacao da tabela */ int i, j; /* utilizada na apresentacao da tabela */ do { /* Pede o tipo de ano e verifica */ printf("\n Ano (0- Normal 1-bissexto) = "); scanf("%d", &ano); while (!((ano == 0) (ano == 1))); do { /* Pede o mes e verifica */ printf(" Mes (1-Jan,..., 12-Dez) = "); scanf("%d", &mes); while (!((mes >= 1) && (mes <= 12))); Cont... Programação 2007/2008 DEEC-IST 5 Legibilidade do código fonte do { /* Pede o dia da semana e verifica */ printf(" Dia da Semana (1-Dom,2-Seg...., 7-Sab.) = "); scanf("%d", &dia_semana); while (!((dia_semana >= 1) && (dia_semana <= 7))); /*Determina o numero de dias de cada mes */ if ((mes == 1) (mes == 3) (mes == 5) (mes == 7) (mes == 8) (mes == 10) (mes ==12)) dias_do_mes = 31; /* else */ if ((mes == 4) (mes == 6) (mes == 9) (mes == 11)) dias_do_mes = 30; /* else */ if (mes == 2) /* Fevereiro */ if (ano == 0) /* Ano normal */ dias_do_mes = 28; else dias_do_mes = 29; Cont... Programação 2007/2008 DEEC-IST 6

4 Legibilidade do código fonte /* Apresenta a tabela*/ /* Posicionar o 1.o dia do mês na tabela */ /* o inicio do mes pode ser diferente do inicio da semana */ printf("\n\n Dom Seg Ter Qua Qui Sex Sab\n"); for (i=1; i<dia_semana; ++i) { printf(" "); /* Escreve os dias no ecra*/ muda = dia_semana; for (j=1; j<=dias_do_mes; ++j) { printf(" %3d", j); /* Escreve o dia */ if (muda == FIM_LINHA) { /* Muda de linha se for necessario */ printf("\n"); muda = 0; /* inicializacao */ muda = muda + 1; /* Para calcular a mudanca de linha */ return (0); Programação 2007/2008 DEEC-IST 7 Legibilidade do código - Normas 1. Cada instrução deve ser colocada numa linha separada. 2. Utilizar nomes para os identificadores (constantes, variáveis, funções) que sugiram o contexto onde são utilizados. 3. Utilizar letras maiúsculas e minúsculas para facilitar a leitura dos identificadores. Utilizar o sublinhado para facilitar a leitura, por exemplo MassadaPonte e Massa_da_Ponte. 4. Separar a zona de declaração das variáveis da zona das instruções com uma ou duas linhas em branco. 5. Utilizar as { em linhas separadas. 6. Efectuar o alinhamento das chavetas correspondentes. 7. As instruções que fazem parte de uma instrução composta { devem estar colocadas n (n>=2) espaços para a direita em relação às chavetas (utilize o tab). 8. Os operadores devem ser separados por um espaço em branco. 9. Todas as funções, incluindo a função main devem ter um comentário a descrever a acção/finalidade, as pré-condições de utilização, autor, data. 10. Devem ser utilizados comentários ao longo de um programa de modo a esclarecer a finalidade de sequências instruções. 11. Devem ser utilizados parenteses curvos para facilitar a leitura na avaliação das expressões. 12. Constantes literais, (exemplo, 3.14 constante PI), que tenham um significado bem preciso (mágico) devem ter um identificador que descreva a finalidade. Programação 2007/2008 DEEC-IST 8

5 Instrução switch Na solução do problema do calendário, 2ª solução, a selecção do número de dias de cada mês, em função do (número do) mês, é realizada por um conjunto de ifs cujas expressões de controlo são muito longas. A leitura desses ifs seria ainda mais confusa se se tivesse incluído o else. Na forma como se apresenta o código, isso significa que o computador efectua, sempre, a avaliação das três expressões de controlo dos ifs, sendo apenas uma delas verdadeira. Se fossem utilizados os elses que estão em comentários isso já não sucederia, mas o código seria de leitura mais difícil. Nas situações em que é necessário efectuar a selecção por comparação com valores numéricos inteiros, e para evitar a situação descrita anteriormente, o C disponibiliza a instrução switch Programação 2007/2008 DEEC-IST 9 Instrução switch Sintaxe: switch ( expressão ) { case Expressão constante : instrução default : instrução Programação 2007/2008 DEEC-IST 10

6 Instrução switch Semântica: Em 1º lugar a expressão do switch é avaliada. Se o resultado for igual a algum dos valores constantes inteiros que se encontram associados a um dos rótulos case então as instruções associadas são executadas. Os valores de cada case têm obrigatoriamente de ser diferentes Se não existir um case cuja expressão constante seja igual ao valor da expressão do switch então o fluxo do programa passa para o rótulo default (se existir) e serão executadas as instruções do default. Atenção: O switch após ter entrado num case executa todas as instruções que vêm a seguir, incluindo as instruções associadas ao rótulo de default. Para controlar esse comportamento são utilizadas as instruções de break ou de return Programação 2007/2008 DEEC-IST 11 Instrução switch Re-escrita do código do Calendário, da 2ª Solução /*Determina o numero de dias de cada mes */ switch (mes) { case 1: case 3: case 5: case 7: case 8: case 10: case 12: dias_do_mes = 31; case 4: case 6: case 9: case 11: dias_do_mes = 30; case 2: if (ano == 0) /* Ano normal */ dias_do_mes = 28; else dias_do_mes = 29; default: printf( Erro no mes = %d \n, mes); return (1); /*termina o programa*/ Programação 2007/2008 DEEC-IST 12

7 Tipos enumerados Nas aulas passadas foram apresentados diversos tipos escalares: Tipo carácter: char Tipo inteiro: int, long int Tipo real: float, double, long double O propósito de cada um desses tipos é o de permitir que o programador possa seleccionar a forma mais adequada de representar informação, de armazenar dados de acordo com o tipo de problema que é necessário solucionar. Para melhor a legibilidade do código, a linguagem C permite que o programador possa definir tipos enumerados. Este tipo permite que se efectue uma associação entre palavras e constantes do tipo inteiro, -1, 0, 5,... As variáveis cujo tipo seja enumerado só podem assumir valores enumerados. Os compiladores produzem mensagens de aviso quando há atribuições com valores discordantes da definição do respectivo tipo enumerado. Programação 2007/2008 DEEC-IST 13 Tipos enumerados Aplicação: Considere-se a utilização dos tipos enumerados como um mecanismo que permite melhorar a legibilidade do código fonte. #include <stdio.h> enum TIPO_ANO {Normal=0, Bissexto; enum MESES {Jan=1, Fev, Mar, Abr, Mai, Jun, Jul, Ago, Set, Out, Nov, Dez; enum DIAS {Dom=1, Seg, Ter, Qua, Qui, Sex, Sab; int main( void ) { enum TIPO_ANO ano; enum MESES mes; int dias_do_mes; ano = Normal; mes = Fev; switch (mes) { case Jan: case Mar: case Mai: Atenção ao ; Nota: Os tipos enumerados começam no valor 0. Mas podem ser alterados com o operador =, exemplo enum PAR_IMPAR {Par = 2, Impar = 1; case Jul: case Ago: case Out: case Dez: dias_do_mes = 31; case Abr: case Jun: case Set: case Nov: dias_do_mes = 30; Cont. Programação 2007/2008 DEEC-IST 14

8 Tipos enumerados Exemplo (cont.), case Fev: if (ano == Normal) /* Ano normal */ dias_do_mes = 28; else dias_do_mes = 29; default: printf("erro no mes = %d \n", mes); return (1); printf("dia do mes = %d", dias_do_mes); return 0; Sugestão: Re-escreva o código do programa calendário utilizando a instrução switch e os tipos enumerados. Programação 2007/2008 DEEC-IST 15