Mas o que são elas?
As convenções de código são técnicas comumente adotadas pelos grandes programadores em todas as linguagens, mas o que são essas convenções e qual a sua importância?
Primeiramente devemos tomar nota de que 80% do custo geral de um software vai em manutenções.
Segundo, dificilmente algum software será mantido por toda sua vida pelo mesmo autor.
Terceiro, as convenções de código aprimoram a legibilidade do programa, permitindo a especialistas entenderem o código de forma mais rápida e claramente.
E por último, se você for querer publicar seu código, certamente desejará ter como produto final um código bem formatado e limpo, não é mesmo?
Vamos então conhecer as regras para definição de código no Perl.
Organização dos Arquivos
O nome de um arquivo Perl deve conter uma das seguintes extensões:
.pl - para programas escritos em Perl
.cgi - para programas Web independente de linguagem
As convenções de código dizem que o arquivo de código-fonte deve ser composto de seções separadas por linhas em branco juntamente com um comentário identificando cada seção.
Não é recomendado fazer arquivos que excedam 2000 linhas de código, pois isto pode gerar incômodo ao programador, além de dificultar sua compreensão.
Para padronizar a estrutura dos arquivos de código-fonte, devemos seguir algumas regras.
- Deve-se iniciar o programa informando o local do interpretador
- Começa o arquivo de código-fonte com comentários introdutórios
- Faz a declaração dos pacotes usados (use)
- Em seguida, faz-se a declaração do que primeiro aparecerá ao usuário
Os pacotes devem ser as primeiras declarações não-comentadas do código.
Antes de declararmos cada tela que aparecerá ao usuário, podemos fazer um comentário descritivo sobre a mesma.
Depois de colocarmos a tela, podemos comentar sobre como implementá-la, se necessário.
Para declararmos as variáveis devemos seguir a seguinte ordem:
- As estáticas devem ser declaradas primeiramente
- E por ultimo os métodos genéricos.
- Os métodos devem ser agrupados por funcionalidade, e não por escopo ou acessibilidade.
Não importa se um método de classe privada tiver no meio de dois métodos públicos. O objetivo é tornar o código mais legível e compreensível.
Code Conventions
Por que utilizar? â— Organização dos Arquivos â— Indentação de Código e Comentários â— Regras para Declaração de Variáveis â— Regras de Instruções, Loop e Retornos â— Regras para Nomes
Edição feita por: Whitesnake, 26/03/2009, 14:40.
