Cara menggunakan komentar di kode Perl

Kode program yang akan dieksekusi oleh komputer. Tapi saya menulis ini kode dan melengkapi orang-orang. Komputer masih sebagai kompleks dan rumit kode — itu hanya tidak akan melakukan. Tapi jika kode mudah untuk memahami manusia, maka ia akan lebih mudah dan lebih cepat untuk menyelesaikan dan itu akan kesalahan lebih sedikit.

Komentar di program ini adalah teks yang dimaksudkan untuk digunakan manusia. Komputer tidak digunakan komentar. Tujuan dari tinjauan untuk membuat kode yang lebih jelas bagi manusia. Komentar sepanjang waktu dalam kode program, ketika seseorang perlu mengubah kode snippet, membaca review dan ia menyederhanakan pemahaman tentang apa yang terjadi di dalam kode.

Tujuan kedua dari review adalah sebuah alat untuk mengembangkan kode. Sering menulis kode ada bagian yang tidak diperlukan, tetapi segera anda akan perlu. Dalam hal ini, fragmen hal ini nyaman untuk komentar kode sampai run-kode debug berikutnya. Ketika pekerjaan berakhir ini komentar potongan kode tidak harus tinggal.

Single-baris komentar

Untuk menulis komentar dalam bahasa pemrograman Perl yang anda butuhkan untuk menempatkan pound #. Semuanya setelah simbol ini ke akhir baris akan menjadi komentar.

Simbol array dapat di awal baris:

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

Atau di depan kisi-kisi bisa menjadi celah:

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

Dan review dapat pergi setelah kode:

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

Review bisa untuk menulis segera setelah simbol pon, tapi untuk dibaca anda harus menempatkan spasi setelah #

#comment without a space
# comment with a space

Jika hash di dalam string, ini bukan review, sebagai bagian dari string:

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

Mengkonfigurasi editor

Ketika ada yang aktif bekerja pada proyek ada kebutuhan untuk komentar beberapa baris kode.

Hal ini sangat mudah untuk mengkonfigurasi editor teks untuk menjadi semudah mungkin. Misalnya untuk membuat editor bekerja seperti ini:

  • sorot semua baris anda ingin komentar
  • klik Ctrl+/
  • hasilnya di depan semua baris yang dipilih simbol muncul #

Multi-baris komentar

Dalam kode program Perl dapat ditulis dokumentasi. Menggunakan khusus markup language POD (singkatan Tua Polos Dokumentasi). POD khusus dirancang untuk untuk menulis teks untuk manusia dalam kode program.

Berikut ini adalah contoh POD markup untuk dokumentasi tentang metode ini:

=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 selalu dimulai dengan yang sama =, setelah tidak ada ruang yang Direktif. Misalnya =head2 atau =item. Simbol = harus selalu berada di awal baris. Jika ia akan ruang, itu tidak akan bekerja.

POD markup selalu berakhir dengan Direktif =cut. Dan sebelum karakter = juga tidak harus kesenjangan.

Menggunakan multiline komentar untuk sementara menghapus kode

Jika anda bekerja pada sebuah proyek, anda akan perlu untuk sementara komentar sepotong kode ini anda bisa menggunakan teknik ini. Sebelum kode yang anda ingin komentar anda butuhkan untuk menulis =a, dan setelah kode =cut:

my $str = 'AB';

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

Semua yang tertulis di antara =a dan =cut akan tersembunyi dari Perl interpreter.

Tapi itu adalah keputusan yang tidak bisa ditinggalkan dalam kode program. =a adalah tidak sah POD Directive dan berbeda POD parser akan memberikan kesalahan ketika bekerja dengan kode yang berisi seperti salah POD.

Artikel lainnya