Perl - Gömülü Belgeler

Pod (Düz Eski Metin) belgelerini Perl modüllerinize ve komut dosyalarınıza gömebilirsiniz. Perl Kodunuzda gömülü belgeleri kullanma kuralı aşağıdadır:

Dokümantasyonunuza boş bir satırla başlayın, a =head1 başında komut verin ve a = ile bitirincut

Perl, koda girdiğiniz Pod metnini yoksayacaktır. Aşağıda, Perl kodunuzun içinde gömülü belgeleri kullanmanın basit bir örneği verilmiştir -

#!/usr/bin/perl

print "Hello, World\n";

=head1 Hello, World Example
This example demonstrate very basic syntax of Perl.
=cut

print "Hello, Universe\n";

Yukarıdaki kod çalıştırıldığında, aşağıdaki sonucu verir -

Hello, World
Hello, Universe

Bölmenizi dosyanın sonuna koyacaksanız ve __END__ veya __DATA__ kesme işareti kullanıyorsanız, ilk Bölme komutunun önüne aşağıdaki gibi boş bir satır koyduğunuzdan emin olun, aksi takdirde daha önce boş bir satır koymayın. the =head1, birçok çevirmen =head1 bir Pod bloğu başlatırken.

#!/usr/bin/perl

print "Hello, World\n";

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

__END__

=head1 Hello, World Example
This example demonstrate very basic syntax of Perl.
print "Hello, Universe\n";

Yukarıdaki kod çalıştırıldığında, aşağıdaki sonucu verir -

Hello, World

=head1 Hello, World Example
This example demonstrate very basic syntax of Perl.
print "Hello, Universe\n";

DATA bölümünü okumadan aynı kod için bir örnek daha alalım -

#!/usr/bin/perl

print "Hello, World\n";

__END__

=head1 Hello, World Example
This example demonstrate very basic syntax of Perl.
print "Hello, Universe\n";

Yukarıdaki kod çalıştırıldığında, aşağıdaki sonucu verir -

Hello, World

POD nedir?

Pod, Perl, Perl programları ve Perl modülleri için belge yazmak için kullanılan, kullanımı kolay bir biçimlendirme dilidir. Pod'u düz metin, HTML, kılavuz sayfaları ve daha fazlası gibi çeşitli biçimlere dönüştürmek için kullanılabilen çeşitli çevirmenler vardır. Kapsül işaretlemesi, üç temel paragraf türünden oluşur:

Ordinary Paragraph - Kalın, italik, kod stili, köprüler ve daha fazlası için sıradan paragraflarda biçimlendirme kodlarını kullanabilirsiniz.
Verbatim Paragraph - Verbatim paragrafları genellikle bir kod bloğu veya herhangi bir özel ayrıştırma veya biçimlendirme gerektirmeyen ve kaydırılmaması gereken başka bir metni sunmak için kullanılır.
Command Paragraph- Bir komut paragrafı, genellikle başlıklar veya listelerin parçaları olarak, tüm metin parçalarının özel olarak işlenmesi için kullanılır. Tüm komut paragrafları = ile başlar, ardından bir tanımlayıcı ve ardından komutun istediği şekilde kullanabileceği rastgele bir metin gelir. Şu anda tanınan komutlar -

=pod
=head1 Heading Text
=head2 Heading Text
=head3 Heading Text
=head4 Heading Text
=over indentlevel
=item stuff
=back
=begin format
=end format
=for format text...
=encoding type
=cut

POD Örnekleri

Aşağıdaki POD'u düşünün -

=head1 SYNOPSIS
Copyright 2005 [TUTORIALSOPOINT].
=cut

Kullanabilirsiniz pod2html Linux'ta bulunan yardımcı program, yukarıdaki POD'u HTML'ye dönüştürmek için aşağıdaki sonucu verecektir -

Ardından, aşağıdaki örneği düşünün -

=head2 An Example List

=over 4
=item * This is a bulleted list.
=item * Here's another item.
=back
=begin html
<p>
Here's some embedded HTML.  In this block I can
include images, apply <span style="color: green">
styles</span>, or do anything else I can do with
HTML.  pod parsers that aren't outputting HTML will
completely ignore it.
</p>

=end html

Yukarıdaki POD'u pod2html kullanarak HTML'ye dönüştürdüğünüzde, aşağıdaki sonucu verecektir -

An Example List
   This is a bulleted list.
   Here's another item.
Here's some embedded HTML. In this block I can include images, apply 
styles, or do anything else I can do with HTML. pod parsers that aren't 
outputting HTML will completely ignore it.