Como usar os comentários no código Perl

O código do programa é executado pelo computador. Mas escrevem e complementam este código de pessoas. O computador ainda o quão difícil e complicado o código — ele simplesmente executa. Mas se o código mais fácil de entender o homem, então será mais fácil e mais rápido para completar e ele vai menos erros.

Comentários no programa é o texto projetado para o homem. O computador não usa comentários. A tarefa de comentários tornar o código mais compreensível para o homem. Os comentários estão no código do programa, quando a pessoa precisa alterar o fragmento de código, ele lê um comentário e é facilita-lhe a compreensão do que está acontecendo no código.

A segunda tarefa de comentários é uma ferramenta no desenvolvimento de código. Muitas vezes é — escreve o código, tem um pedaço que agora não é necessário, mas muito em breve vai precisar. Neste caso, este fragmento de código conveniente comentar, até запускаешь-отлаживаешь o código ao lado. Quando o trabalho termina tais закомментированных pedaços de código para ficar, não deve.

Comentários de linha única

Para escrever um comentário em linguagem de programação Perl precisa colocar um símbolo da grade #. Tudo depois disso, o símbolo e até o final da linha vai ser o comentário.

O símbolo de grade pode ser no início da linha:

# This is a comment
my @arr = (1..10);

Ou antes de grade podem ser espaços:

foreach my $el (@arr) {
    # One more comment
    warn $el;
}

E também o comentário pode ir após o código:

my @arr = (1, 2, 3); # some description for @arr
my %h; # explanation of %h

Um comentário pode escrever imediatamente após o símbolo de libra, mas para facilitar a leitura vale a pena colocar um espaço depois de #

#comment without a space
# comment with a space

Se o símbolo da grade está dentro de uma linha, então não é um comentário, e a parte de comando:

my $str = 'Line 1
# This is not a comment, but part of a string variable
Line 2';

O editor de configuração

Quando está ativo o projeto é a necessidade de comentar várias linhas de código.

É muito conveniente configurar o editor de texto para isso você pode fazer da maneira mais fácil possível. Por exemplo, você pode para fazer o editor funcionou assim:

  • выделяешь todas as linhas que deseja comentar
  • clique Ctrl+/
  • o resultado antes de todas as linhas de destaque que aparece o símbolo de #

Comentário de várias linhas

No código do programa Perl pode escrever documentação. Para isso, é utilizado um linguagem de marcação POD (isso significa Plain Old Documentation). O POD é projetado especialmente para escrever um texto para a pessoa no código do programa.

Aqui está um exemplo de um POD de marcação com a documentação sobre o método:

=head2 get_name

    my $name = $obj->get_name();

Returns the name of the Person stored in the object.

The return value is a scalar with length >= 1 and <= 100.

=cut

sub get_name {
    my ($self, @other) = @_;

    die 'get_name should not get any parameters' if @other;

    return $self->{_name};
}

POD marcação sempre começa com o caractere é igual a =, após o qual imediatamente, sem espaço vai directiva. Por exemplo =head2 ou =item. O símbolo = deve ser sempre no início de uma linha. Se diante dele serão espaços em branco, isto não vai funcionar.

POD marcação sempre termina com a directiva =cut. E antes do símbolo de = também não deve haver espaços.

O uso de múltiplas linhas de comentários temporária, cortando o código

Se estiver a trabalhar em um projeto, você precisa comentar temporariamente algum pedaço de código que você pode usar essa técnica. Antes do código que você precisa comentar você precisa escrever =a, e depois que o código =cut:

my $str = 'AB';

=a
foreach my $el (1..10) {
    parse_index($el);
}
=cut

Tudo o que está escrito entre =a e =cut será escondido do interpretador Perl.

Mas é uma decisão que não pode ser deixada no código do programa. =a não é валидной POD directiva e diferentes analisadores POD serão retornar erros ao trabalhar com o código que contém tal um POD.

Outros artigos