Regras para Nomes – Naming Conventions

As convenções para nomes tornam os programas mais compreensíveis, mais fáceis de ler. Eles podem nos ajudar a identificar, por exemplo, quando temos uma constante, um pacote ou uma classe. Isto pode ser de muita ajuda para entendermos o código.

Vejamos como são essas convenções:
composta,

• Subrotinas ou funções  Os métodos devem ser verbos, se tiver mais de uma palavra, definimos a primeira palavra com a inicial minúscula e as restantes com a inicial maiúscula.
  Exemplo: &pegarFundo()
• Variáveis  As variáveis também devem ser definidas com a inicial minúscula e as restantes com a inicial maiúscula. a primeira letra deve ser sempre maiúscula. Tente fazer com que o nome de suas variáveis seja simples e descritiva. Use palavras inteiras, evite acrônimos e abreviações (a menos que as abreviações sejam muito mais usadas do que a forma completa, como URL ou HTML)
  Exemplo: $tamanhoTotal
• FILEHANDLES  Os manipuladores de arquivos devem ser todas em maiúsculo separando as palavras por underscores (“_”)
  Exemplo: MAX_WIDTH = 999; 

Os nomes das variáveis devem ser curtas porém objetivas.

A escolha do nome das variáveis deve ser mnemônica – isto é, projetadas para que o observador comum compreenda a sua função. Variáveis de apenas uma letra devem ser evitadas, exceto para variáveis temporárias que serão descartadas. Nomes comuns para variáveis temporárias são i, j, k, m, e n para numéricos integers; c, d, e e para caracteres (strings);

Perl Code Conventions
[ 1 | 2 | 3 | 4 | 5 | 6 ]

Regras de Instruções, Loop e Retornos

Quando estivermos definindo as instruções/expressões do programa devemos nos lembrar de que não podemos ter mais de uma instrução por linha. Muito menos querer agrupar múltiplas instruções, a menos que tenhamos um motivo óbvio.

As instruções compostas são instruções que contem listas de ações dentro de suas chaves “{ e }“

O conteúdo dentro da instrução composta deve ser indentado sempre um nível para dentro da declaração da instrução. A chave de abertura “{“ deve ser aberta no fim da linha onde se declara a instrução.

Já a chave de encerramento”}“ deve ficar em uma única linha, que por sua vez esta estará indentada com a do inicio da instrução. As “chaves” devem ser usadas para circundar instruções, mesmo se estas forem compostas de apenas um elemento de um if-else ou for, por exemplo.

Isto irá evitar que acidentalmente causemos erro no código do programa por adicionar instruções sem incluirmos as chaves.

Comandos de retorno e loop

As instruções de retorno (return) não devem usar parênteses, a menos que esta seja de declaração óbvia, como a definição dos parâmetros de uma função.

Quando estivermos trabalhando com a instrução for devemos estar atentos para não colocar mais do que três variáveis de inicialização e atualização, pois isto tornaria o código mais complexo.

Se precisar, podemos usar instruções separadas antes do loop (para cumprir a clausula de inicialização) ou no fim do loop (para atualizar o loop).

Perl Code Conventions
[ 1 | 2 | 3 | 4 | 5 | 6 ]

Regras para Declaração de Variáveis

Para melhor aproveitar esses comentários, devemos definir todas as declarações na mesma colocação, ou seja, logo depois de começar um bloco. Um bloco é qualquer código rodeado por { e } .

Não devemos esperar para declarar variáveis quando formos precisar delas; isto pode confundir um programador descuidado e embaralhar o escopo do código.

Os comentários podem funcionar muito bem se juntamente optarmos por fazer declarações únicas por linha, ainda mais quando temos variáveis de tipos diferentes.

Nunca devemos misturá-las, ao contrário, devemos separar em outra linha e comentar o que cada variável faz. Isso encorajará novos comentários.

Outro erro que precisa de atenção é o de declarar variáveis locais com nomes iguais a de outras variáveis de nível superior.

Devemos tentar iniciar uma variável local logo quando ela é criada. O único motivo para não se fazer isso é quando o seu valor depende primeiramente de algum processamento computacional.

As funções ou partes de código devem ser formatados sem espaço entre o nome do método e o parêntese “(“ que dá inicio a lista de parâmetros.

O sinal de abrir chave “{“ de um método ou classe deve aparecer sempre no fim da mesma linha da declaração. Já o sinal de fechar chave “}” deve começar em uma linha em branco indentada juntamente com o correspondente que abriu a instrução. Os métodos são separados por uma linha em branco.

Evite definir varias variáveis em uma única declaração. Isto dificulta a leitura.

Não use o operador de incremento de valor em um local que possa facilmente confundir com o operador de igualdade.

Não use várias definições de valor como tentativa de melhorar a performance do programa. Isto é tarefa para o compilador, e na prática, isto dificilmente ajuda.

Use parênteses para separar uma expressão das outras para evitar problemas com a precedência de operação.

Mesmo se a operação parecer clara para você, ela pode não ser para outros – você nunca deve supor que os outros programadores sabem o mesmo que você.

O nome de uma variável Perl deve conter somente caracteres, números e/ou underlines.

• As variáveis devem começar com um sinal especial (como $, @ % etc), seguido do nome da variável. Estas siglas identificam qual o tipo da variável scalar, array, ou hash
• O primeiro caractere deve ser um underline ou uma letra.
• Os nomes das variáveis são case sensitive. Então as seguintes variáveis $var, $VAR, $VaR, são todas diferentes uma das outras.
• Nomes válidos para variáveis Perl são:
  $nome, $_yy, $PI , $data1, $db2nome
• Nomes inválidos para variáveis Perl são:
  • $1dd (pois deve começar com letra ou underline)
  • $nome# (o caractere especial # não é permitido)
  • $nome@20 (o caractere especial @ não é permitido)
  • variavel (não há nenhuma sigla que identifica o tipo da variável)

 

Perl Code Conventions
[ 1 | 2 | 3 | 4 | 5 | 6 ]