Jak korzystać komentarze w Perl kodzie

Kod programu odbywa się komputerem. Ale piszą i uzupełniają ten kod ludzi. Komputera tak jak trudny i skomplikowany kod — on po prostu go wykona. Ale jeśli kod jest łatwo zrozumieć człowieka, to będzie łatwiej i szybciej uzupełnić i w nim będzie mniej błędów.

Komentarze w programie — jest to tekst przeznaczony dla ludzi. Komputer nie wykorzystuje komentarze. Zadaniem oceny uczynić kod bardziej zrozumiały dla człowieka. Komentarze cały czas są w kodzie programu, gdy człowiekowi trzeba zmienić fragment kodu, czyta komentarz i to ułatwia mu zrozumienie, co się dzieje w kodzie.

Drugie zadanie komentarzy — jest to narzędzie przy tworzeniu kodu. Często piszesz kod, kawałek, który teraz nie jest potrzebny, ale wkrótce potrzebne. W tym przypadku ten fragment kod wygodne komentarz, gdy otwierasz-отлаживаешь kod obok. Kiedy praca się kończy takich закомментированных kawałków kodu zostać nie powinna.

Jednowierszowych komentarze

Aby napisać komentarz w języku programowania Perl trzeba postawić znak kratki #. Wszystko po znaku, aż do końca wiersza może być komentarzem.

Symbol kratka może być na samym początku wiersza:

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

Lub przed kratkami mogą być spacje:

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

A także komentarz może iść po kodzie:

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

Komentarze można pisać raz po znaku kraty, ale dla czytelności warto postawić spację po #

#comment without a space
# comment with a space

Jeśli symbol rusztu znajduje się wewnątrz wiersza, to nie komentarz, a część wiersza:

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

Konfiguracja edytora

Gdy jest aktywna praca nad projektem jest konieczność komentarz raz kilka linijek kodu.

Bardzo wygodne, aby ustawić edytor tekstu aby to można było zrobić, jak tylko to możliwe. Na przykład można zrobić aby edytor pracował tak:

  • выделяешь wszystkie wiersze, które chcesz skomentować
  • wystarczy nacisnąć Ctrl+/
  • wynik — przed wszystkimi wersy które zostały wyróżnione pojawia się symbol #

Komentarze wielowierszowe

W kodzie Perl programy można pisać dokumentację. Do tego celu służy specjalny język znaczników POD (to oznacza Plain Old Documentation). POD specjalnie zaprojektowany, aby napisać tekst dla osoby w kodzie programu.

Oto przykład POD znaczników z dokumentacją o metodę:

=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 układ zawsze zaczyna się od znaku równa =, po którym od razu, bez spacji idzie dyrektywa. Na przykład =head2 lub =item. Symbol = musi być zawsze na samym początku wiersza. Jeśli przed nim będą luki, to nie będzie działać.

POD układ zawsze kończy się dyrektywą =cut. I przed symbolem = też nie powinno być spacji.

Korzystanie z wielowierszowych komentarzy do tymczasowego odcinając kodu

Jeśli podczas pracy nad projektem trzeba tymczasowo wypowiedzieć się jakiś kawałek kodu, to dla tego można wykorzystać taki odbiór. Przed kodem który trzeba skomentować trzeba napisać =a, a po kodzie =cut:

my $str = 'AB';

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

Wszystko co jest napisane między =a i =cut będzie ukryte od interpretera Perl.

Ale to rozwiązanie, które nie może zostać w kodzie programu. =a nie jest валидной POD dyrektywą i różne parsera POD wydawać błędy podczas pracy z kodem w którym zawarta jest taka niepoprawna POD.

Inne artykuły