Hvordan man bruger kommentarer i Perl-kode

Programkoden udføres af en computer. Men jeg skriver denne kode og supplere mennesker. Computeren er stadig lige så kompleks og indviklet kode — det vil blot udføre. Men hvis den kode, der er let at forstå, at manden, vil det være lettere og hurtigere at udføre, og det vil færre fejl.

Kommentarer i programmet er teksten, der er bestemt til human brug. Bruger computeren ikke bemærkninger. Formålet med gennemgangen at gøre koden klarere for mennesker. Kommentarer hele tiden i programmet kode, når en person har behov for at ændre kodestykket, læser den anmeldelse, og er han forenkler forståelse af, hvad der sker i koden.

Det andet mål er et værktøj, når man udvikler kode. Ofte skriver kode der er et stykke, der er ikke nødvendigt, men meget snart vil du har brug for. I dette tilfælde, fragment det er praktisk at kommentere koden, indtil køre-debug kode, næste. Når arbejdet slutter disse er kommenteret ud stykker af kode, bør ikke opholde sig.

Enkelt-linje-kommentarer

For at skrive en kommentar i programmeringssproget Perl er du nødt til at sætte pund #. Alt efter dette symbol, for at i slutningen af linjen vil være en kommentar.

Symbolet array kan være i begyndelsen af linjen:

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

Eller er placeret foran kølergrillen, kan være huller:

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

Og anmeldelse kan gå efter koden:

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

Anmeldelse kan skrive umiddelbart efter pund symbol, men af hensyn til læsbarheden bør du sætte en plads efter #

#comment without a space
# comment with a space

Hvis hash er inde i strengen, det er ikke en anmeldelse, som en del af en streng:

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

Konfiguration af editor

Når der er et aktivt arbejde på projektet, der er et behov for at kommentere flere linjer af kode.

Det er meget praktisk at konfigurere tekst editor til at være så let som muligt. For eksempel for at gøre redaktør arbejde som dette:

  • fremhæv alle de linjer, du ønsker at kommentere
  • klik på Ctrl+/
  • resultatet er foran alle de linjer, som blev udvalgt symbol vises #

Multi-line kommentarer

I den kode Perl program kan være skriftlige dokumentation. Det bruger en speciel markup language POD (det står for Plain Old Documentation). POD specielt designet til at til at skrive teksten for mennesker i programkoden.

Her er et eksempel POD markup til dokumentation af metode:

=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 markup starter altid med lige =, efter at der ingen plads er Direktiv. For eksempel =head2 eller =item. Symbol = skal altid være i starten af rækken. Hvis han vil rum, vil det ikke fungere.

POD markup altid ender med et Direktiv, der =cut. Og før det tegn, = også bør ikke være huller.

Brug multiline kommentarer til midlertidigt at fjerne kode

Hvis du arbejder på et projekt, skal du midlertidigt vil kommentere et stykke kode til dette du kan bruge denne teknik. Før den kode, du ønsker at kommentere skal du skrive =a, og efter koden =cut:

my $str = 'AB';

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

Alle, der er skrevet mellem =a og =cut vil være skjult fra Perl-fortolkeren.

Men det er en beslutning, som ikke stå i programmet kode. =a er ikke en gyldig POD Direktiv og forskellige POD-parsere vil give fejl, når du arbejder med kode, som indeholder en sådan forkert POD.

Andre artikler