Dokumentasi POD Perl


Perl boleh membenamkan dokumen POD (Plain Old Documentation) dalam modul atau skrip.

POD ialah bahasa penanda yang ringkas dan mudah digunakan (bahasa penanda).

Peraturan penggunaan dokumen POD:

Dokumen POD bermula dengan =head1, =cut berakhir dengan =head1<🎜 Tambahkan baris kosong sebelum dan selepas =potong.

Perl mengabaikan dokumentasi dalam POD. Contohnya adalah seperti berikut: 

#!/usr/bin/perl

print "Hello, World\n";

=head1 Hello, World 实例
这是一个 Perl 的简单实例。
=cut

print "Hello, php\n";

Laksanakan program di atas, hasil output ialah: 

Hello, World
Hello, php

Kita juga boleh menggunakan "__END__" atau "__DATA__" untuk "mengulas" semua kandungan selepas baris: 

#!/usr/bin/perl

print "Hello, World\n";

while(<DATA>){
  print $_;
}

__END__

=head1 Hello, World 实例
这是一个 Perl 的简单实例。
print "Hello, php\n";

Laksanakan atur cara di atas, hasil output ialah:

Hello, World

=head1 Hello, World 实例
这是一个 Perl 的简单实例。
print "Hello, php\n";

Contoh berikut tidak membaca dokumen POD:

#!/usr/bin/perl

print "Hello, World\n";

__END__

=head1 Hello, World 实例
这是一个 Perl 的简单实例。
print "Hello, php\n";

Laksanakan atur cara di atas, hasil keluaran ialah:

Hello, World

Apakah itu POD?

Pod (Dokumentasi Lama Biasa), ialah bahasa penanda yang ringkas dan mudah digunakan (bahasa penanda), yang sering digunakan untuk menulis dokumen dalam program dan modul perl.

Penukar Pod boleh menukar Pod kepada banyak format, seperti teks, html, man, dsb.

Bahasa penanda Pod mengandungi tiga jenis asas asas: normal, asal dan perintah.

  • Perenggan Biasa: Anda boleh menggunakan kod pemformatan dalam perenggan biasa, seperti muka tebal, condong atau gaya kod, garis bawah, dsb.

  • Perenggan asal : Perenggan asal, digunakan untuk blok kod atau bahagian lain yang tidak memerlukan pemprosesan penukar dan tidak memerlukan penyusunan semula perenggan.

  • Perenggan perintah : Perenggan perintah bertindak pada keseluruhan dokumen, biasanya digunakan untuk penetapan tajuk atau penanda senarai.

    Semua perenggan arahan (yang hanya satu baris panjang) bermula dengan "=", diikuti dengan pengecam. Teks seterusnya akan dipengaruhi oleh arahan ini. Kini perintah yang digunakan secara meluas termasuk 

    =pod (开始文档)
=head1 标题文本
=head2 标题文本
=head3 标题文本
=head4 标题文本
=over 缩进空格数量
=item 前缀
=back (结束列表)
=begin 文档格式
=end 结束文档格式
=for 格式文本
=encoding 编码类型
=cut (文档结束)

Dalam perl, anda boleh menggunakan pod2html **.pod >**.html untuk menjana dokumen pod dalam format html.

Pertimbangkan contoh POD berikut: 

=begin html
=encoding utf-8

=head1 php中文网

=cut

Kod ini akan disalin daripada teks asal apabila pod2html digunakan.

Gunakan perintah pod2html untuk melaksanakan dan menukarnya kepada kod HTML: 

$ pod2html test.pod > test.html

Buka test.html dalam penyemak imbas, bahagian pautan ialah indeks, seperti yang ditunjukkan di bawah:

Contoh berikut menulis HTML terus dalam dokumen POD:

=begin html
=encoding utf-8

<h1>php中文网</h1>
<p> www.php.cn </p>

=end html

pod2html akan menyalin teks asal kod ini.

Gunakan perintah pod2html untuk melaksanakan dan menukarnya kepada kod HTML: 

$ pod2html test.pod > test.html

Buka test.html dalam penyemak imbas, bahagian pautan ialah indeks, seperti yang ditunjukkan di bawah:

←