Início > Artigos > Indentação de Código e Comentários

Indentação de Código e Comentários

Outro fator essencial para a organização do código e boa legibilidade é a indentação do código.

Sempre devemos usar quatro espaços como unidade de medição.

O comprimento de uma linha não pode exceder 8 caracteres, deve ser de no máximo 70 caracteres.

Um comprimento maior poderia causar problemas na hora de imprimir o código, por exemplo.

Quando formos quebrar linhas por falta de espaço, devemos nos lembrar dos seguintes princípios:

  • Sempre podemos quebrar linha após uma vírgula ou antes de um operador.
  • É melhor optar por quebras maiores do que por quebras menores.
  • O alinhamento da nova linha deve ser junto com o começo da expressão iniciada na linha anterior.Mas se essas regras estiverem causando confusão ou espremendo a margem direita, então apenas indente 8 espaços.

Comentários

Os programas em Perl tem apenas um tipo de comentário.

Deve ser implementado usando o simbolo #.

É importante lembrar que os comentários não devem ser rodeados por caixas largas desenhadas com asteriscos ou outros caracteres.

Quando precisar de comentários especiais, use XXX em um comentário para indicar que alguma coisa é artificial, mas que funciona.

Use FIXME para indicar algo que é artificial mas que não funciona.

Estes 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.

Linhas em Branco

As linhas em branco auxiliam na fácil compreensão por separar trechos de código que são relacionados logicamente. Estes trechos podem incluir seções de um arquivo de código fonte ou declarações de funções.

De qualquer forma os espaços devem ser dados entre métodos, variáveis locais de um método e sua primeira instrução, antes de um comentário de bloco ou linha única, e em seções lógicas dentro de um método a fim de melhorar sua compreensão.

Outra técnica que aumenta a legibilidade de um arquivo de códigos é o uso de espaços em branco. Mas lembre-se de usa-lo de maneira adequada:

  • Os parênteses que delimitam expressões devem ser separados por um espaço, porem os parênteses que delimitam os argumentos de um método não devem ser separados, pois isto ajuda a distinguir expressões de chamadas de métodos.
  • Também usamos espaços depois das vírgulas em listas de argumentos. 
  • Separamos todos os operadores, exceto “.” de seus operandos,  a menos quando os operadores são unários (“++”/”–“).

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

Categorias:Artigos
  1. 14 junho, 2009 às 6:21 pm

    muito bom, adicionei aos favoritos para consultá-lo sempre que necessário.
    – solicitação de informação (se possível): a comunicação com a pasta cgi-bin não está dando certo, quando tento em localhost (pra teste) aparece a seguinte informação “The server encountered an internal error or misconfiguration and was unable to complete your request”, e quando tento num servidor remoto, não retornam o html correto. – aonde pode estar acontecendo o erro? (todos os locais possíveis)
    valeu.

    • Whitesnake
      30 junho, 2009 às 11:21 am

      Olá Frank, quando há este tipo de erro, pode ser tanto erro de sintaxe em alguma parte de seu código, como erro na localização do interpretador perl na primeira linha…

      Verifique se a primeira linha indica o local correto de onde está instalado o interpretador Perl em sua máquina: (Por ex.: #!C:/perl/bin/perl ) no windows, (ou #!/usr/bin/perl ) no Linux

      Além disso é preciso ter certeza de que o cabeçalho HTML está sendo enviado.

      Para isso, defina na segunda linha o seguinte:

      print “Content-type:text/html\n\n”;

      E para verificar se há algum erro de sintaxe, inclua na terceira linha o módulo CGI Carp com:

      use CGI::Carp(fatalsToBrowser);

      Bem, é isso!

      Com estes três passos você conseguirá rodar seu script e identificar possíveis erros em seu código!

      Se precisar de mais ajuda é só dar um toque.

      Abraços

  1. No trackbacks yet.

Deixe uma resposta

Preencha os seus dados abaixo ou clique em um ícone para log in:

Logotipo do WordPress.com

Você está comentando utilizando sua conta WordPress.com. Sair / Alterar )

Imagem do Twitter

Você está comentando utilizando sua conta Twitter. Sair / Alterar )

Foto do Facebook

Você está comentando utilizando sua conta Facebook. Sair / Alterar )

Foto do Google+

Você está comentando utilizando sua conta Google+. Sair / Alterar )

Conectando a %s

%d blogueiros gostam disto: