Come utilizzare i commenti in Perl codice

Il codice del programma viene eseguito in un computer. Ma scrivono e si completano questo codice di persone. Computer importa quanto complessa e intricata codice — è solo sua eseguire. Ma se il codice è facile da capire di una persona, allora sarà più facile e più veloce integrare e sarà meno errori.

Commenti in programma — si tratta di un testo progettato per l'uomo. Il computer non utilizza commenti. Compito commenti rendere il codice più comprensibile per l'uomo. Commenti per tutto il tempo sono nel codice di un programma, quando una persona ha bisogno di cambiare il frammento di codice, si legge un commento e questo semplifica lui la comprensione di ciò che accade nel codice.

La seconda sfida commenti — questo strumento durante lo sviluppo del codice. Spesso accade — scrive il codice c'è un pezzo che non ci serve, ma molto presto bisogno. In questo caso, questo frammento codice comodo commentare, mentre poi-отлаживаешь codice accanto. Quando il lavoro finisce video закомментированных pezzi di codice non deve rimanere.

Commenti a riga singola

Per scrivere un commento in un linguaggio di programmazione Perl bisogno di mettere il simbolo cancelletto #. Tutti dopo il carattere e fino alla fine della riga sarà un commento.

Simbolo griglia può essere all'inizio della riga:

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

O prima della griglia possono essere lacune:

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

E anche il commento può andare dopo il codice:

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

Commento puoi scrivere subito dopo il simbolo di cancelletto, ma per comodità di lettura vale la pena di mettere uno spazio dopo #

#comment without a space
# comment with a space

Se il simbolo si trova all'interno di una stringa, non un commento, ma una parte di stringa:

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

Configurazione dell'editor

Quando è attivo il progetto è la necessità di commentare subito un paio di righe di codice.

Molto comodo impostare un editor di testo per questo può essere fatto nel modo più semplice possibile. Ad esempio, è possibile fare per editor lavorato in questo modo:

  • enfatizzando tutte le righe che hanno bisogno di commentare
  • premi Ctrl+/
  • in diretta — prima di tutte le righe che sono state evidenziate appare il simbolo #

Commenti su più righe

Nel codice Perl programma è possibile scrivere documentazione. Per questo viene utilizzato un linguaggio di markup POD (questo è l'acronimo di Plain Old Documentation). POD è appositamente progettato per scrivere il testo per l'uomo in codice di un programma.

Ecco un esempio di un POD di markup con la documentazione pro metodo:

=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 inizia sempre con un carattere uguale =, dopo il quale una volta senza spazio va direttiva. Ad esempio =head2 o =item. Simbolo = deve sempre essere all'inizio della riga. Se davanti a lui ci saranno gli spazi, questo non funzionerà.

POD markup finisce sempre direttiva =cut. E prima del simbolo = anche non ci devono essere spazi.

L'uso di commenti su più righe per temporanea tagliando codice

Se si lavora su un progetto è necessario temporaneamente commentare qualche pezzo di codice, per questo è possibile utilizzare questo tipo di accoglienza. Prima del codice che serve per commentare è necessario scrivere =a, e dopo il codice =cut:

my $str = 'AB';

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

Tutto ciò che è scritto tra =a e =cut sarà nascosto da interprete Perl.

Ma è una decisione che non può essere lasciato in codice di un programma. =a non è una POD direttiva e diversi parser POD darà errore quando si lavora con il codice che contiene tale errata POD.

Altri articoli