Dokumentasi Perl POD

Penulis：Eve Cole Waktu Pembaruan：2024-12-24 16:24:01

Di Perl, dokumen POD (Plain Old Documentation) dapat disematkan dalam modul atau skrip.

POD adalah bahasa markup (bahasa markup) yang sederhana dan mudah digunakan.

Aturan penggunaan dokumen POD:

Dokumen POD dimulai dengan =head1 dan diakhiri dengan =cut . Tambahkan baris kosong sebelum =head1 dan setelah =cut .

Perl mengabaikan dokumentasi dalam POD. Contohnya adalah sebagai berikut:

Contoh

#!/usr/bin/Perl mencetak " Halo, Dunia n " ; =head1 Halo, Dunia Contoh Ini adalah contoh Perl yang sederhana. = potong mencetak " Halo, Codercto n " ;

Dengan mengeksekusi program di atas, hasil keluarannya adalah:

 Halo DuniaHalo, Codercto

Kita juga dapat menggunakan "__END__" atau "__DATA__" untuk "mengomentari" semua konten setelah baris:

Contoh

#!/usr/bin/Perl mencetak " Halo Dunia n " ; sementara ( < DATA > ) { mencetak $_ ; } __AKHIR__ =head1 Halo, Contoh Dunia Ini adalah contoh sederhana dari Perl. print "Halo, Codercton";

Dengan mengeksekusi program di atas, hasil keluarannya adalah:

 Halo, Dunia=head1 Halo, Contoh Dunia Ini adalah contoh Perl sederhana. print "Halo, Codercton";

Contoh berikut tidak membaca dokumen POD:

Contoh

#!/usr/bin/Perl mencetak " Halo Dunia n " __END__ =head1 Halo, Contoh Dunia Ini adalah contoh sederhana dari Perl. print "Halo, Codercton";

Dengan mengeksekusi program di atas, hasil keluarannya adalah:

 Halo, Dunia

Apa itu POD?

Pod (Plain Old Documentation) adalah bahasa markup (bahasa markup) yang sederhana dan mudah digunakan, yang sering digunakan untuk penulisan dokumen dalam program dan modul Perl.

Konverter Pod dapat mengonversi Pod ke dalam banyak format, seperti teks, html, man, dll.

Bahasa markup Pod berisi tiga tipe dasar dasar: normal, tekstual, dan perintah.

Paragraf biasa : Anda dapat menggunakan kode pemformatan dalam paragraf biasa, seperti huruf tebal, miring, atau gaya kode, garis bawah, dll.

Paragraf asli : Paragraf asli, digunakan untuk blok kode atau bagian lain yang tidak memerlukan pemrosesan konverter, dan tidak memerlukan penataan ulang paragraf.

Paragraf perintah : Paragraf perintah berlaku untuk keseluruhan dokumen dan biasanya digunakan untuk pengaturan judul atau penandaan daftar.

Semua paragraf perintah (yang panjangnya hanya satu baris) dimulai dengan "=", diikuti dengan pengenal. Teks selanjutnya akan terpengaruh oleh perintah ini. Sekarang banyak digunakan perintah include

 =pod (dokumen awal)=teks judul head1=teks judul head2=teks judul head3=teks judul head4=lebih dari jumlah spasi indentasi=awalan item=belakang (daftar akhir)=mulai format dokumen=format dokumen akhir akhir=untuk format teks =encoding jenis pengkodean=potong (akhir dokumen)

Di Perl, Anda dapat menggunakan pod2html **.pod >**.html untuk menghasilkan dokumen pod dalam format html.

Pertimbangkan contoh POD berikut:

Contoh

=mulai html=pengkodean utf-8 =Tutorial Pemrogram head1 =potong

Saat pod2html digunakan, kode ini akan disalin dari teks aslinya.

Gunakan perintah pod2html untuk mengeksekusi dan mengubahnya menjadi kode HTML:

 $ pod2html tes.pod > tes.html

Buka test.html di browser, bagian linknya adalah indeks, seperti gambar di bawah ini:

Contoh berikut menulis HTML langsung di dokumen POD:

 =begin html=pengkodean utf-8<h1>Tutorial Pembuat Kode</h1><p> www.codercto.com </p>=akhir html

Saat pod2html digunakan, kode ini akan disalin dari teks aslinya.

Gunakan perintah pod2html untuk mengeksekusi dan mengubahnya menjadi kode HTML:

 $ pod2html tes.pod > tes.html

Buka test.html di browser, bagian linknya adalah indeks, seperti gambar di bawah ini: