Wie Sie Kommentare in Perl-Code

Code-Programm von einem Computer ausgeführt wird. Aber schreiben und ergänzen diesen Code Menschen. Computer immer noch wie komplexe und komplizierte Code — es geht nachkommt. Aber wenn der Code leicht zu verstehen Mann, dann wird es einfacher und schneller zu ergänzen und in ihm wird weniger Fehler.

Kommentare im Programm — Text ist konzipiert für eine Person. Computer nicht verwendet Kommentare. Aufgabe Kommentare machen den Code verständlicher für die Menschen. Kommentare sind immer im Code des Programms, wenn ein Mensch braucht, ändern Sie das Code-snippet, er liest den Kommentar und das erleichtert ihm das Verständnis was passiert im Code.

Die zweite Aufgabe Beurteilung ist ein Instrument bei der Entwicklung von Code. Oft — schreibst Code, es gibt das Stück jetzt nicht brauchen, aber sehr bald brauchen werden. In diesem Fall ist dieses Fragment Code bequem auskommentieren, bis das starten-отлаживаешь Code in der Nähe. Wenn die Arbeit beendet solche закомментированных Teile des Codes bleiben sollte.

Einzeilige Kommentare

Um einen Kommentar zu schreiben in der Programmiersprache Perl brauchen, um die Rautetaste #. Alle nach diesem Zeichen bis zum Zeilenende ein Kommentar.

Zeichentabelle kann am Anfang der Zeile:

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

Oder vor einem Gitter eingeschlossen werden:

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

Und auch der Kommentar nach dem Code gehen kann:

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

Einen Kommentar schreiben kann unmittelbar nach einem Nummernzeichen, aber zur besseren Lesbarkeit ein Leerzeichen nach #

#comment without a space
# comment with a space

Wenn die Rautetaste befindet sich innerhalb der Zeile, dann ist dies kein Kommentar, sondern Teil der Zeile:

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

Konfigurieren Sie den Editor

Wenn es eine aktive Arbeit an dem Projekt ist die Notwendigkeit, mehrere Zeilen auskommentieren von Code.

Sehr bequem, die Text-Editor um so einfach wie möglich machen. Zum Beispiel können Sie machen damit der Editor funktionierte hier so:

  • выделяешь alle Zeilen, die Sie auskommentieren
  • drückst Ctrl+/
  • das Ergebnis — vor allem die Zeilen wurden hervorgehoben erscheint das Symbol #

Mehrzeilige Kommentare

Im Code der Perl-Programme schreiben können in der Dokumentation. Dazu wird eine spezielle Markup-Sprache POD (dies steht für Plain Old Documentation). POD wurde speziell entwickelt, um schreiben den Text für den Menschen im Code des Programms.

Hier ist ein Beispiel für POD-Markup Dokumentation über die Technik:

=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 beginnt immer mit dem Zeichen noch =, nach dem unmittelbar, ohne Leerzeichen geht die Richtlinie. Zum Beispiel =head2 oder =item. Symbol = muss immer am Anfang der Zeile. Wenn vor ihm werden Leerzeichen, dann wird es nicht funktionieren.

POD-Markup-Richtlinie endet immer =cut. Und vor dem = sollte auch keine Leerzeichen.

Verwendung von mehrzeiligen Kommentaren für die vorübergehende Ausblendung kurzer Code

Wenn Sie bei der Arbeit an einem Projekt müssen Sie vorübergehend auskommentieren ein Codefragment, das für diese Sie können hier diese Technik. Vor dem Code müssen die auskommentieren schreiben müssen =a, und nach dem Code =cut:

my $str = 'AB';

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

Alles, was geschrieben ist zwischen =a und =cut wird versteckt vom Perl-Interpreter.

Aber es ist eine Entscheidung, die nicht verlassen kann, im Code des Programms. =a ist nicht валидной POD-Richtlinie und verschiedene Parser POD ausgeben werden Fehler bei der Arbeit mit Code in dem eine solche falsche POD.

Andere Artikel