Dokumentacja Perl POD

Perl może być osadzone POD (Plain Old Dokumentacja) w dokumentacji modułu lub skryptu.

POD jest prosty i łatwy w użyciu języka znaczników opartych (markup language).

Dokumentacja POD przy użyciu reguł:

Dokumentacja POD zaczyna= head1, = cięciakońca, a przed= head1= wyciąć po dodaniu pusty wiersz.

Perl ignoruje dokumentacja POD. Przykłady są następujące:

#!/usr/bin/perl

print "Hello, World\n";

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

print "Hello, w3big\n";

Powyższy program, wyjście jest:

Hello, World
Hello, w3big

Możemy również użyć "__END__" lub "__DATA__" po zawartości linii, gdzie wszystkie "komentarze" OUT:

#!/usr/bin/perl

print "Hello, World\n";

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

__END__

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

Powyższy program, wyjście jest:

Hello, World

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

Poniższe przykłady nie są odczytywane dokumentację POD:

#!/usr/bin/perl

print "Hello, World\n";

__END__

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

Powyższy program, wyjście jest:

Hello, World

Czym jest POD?

Pod (Plain Old dokumentacja), jest prosty i łatwy w użyciu języka znaczników opartych (markup language), jest on często stosowany w Perl programów i modułów napisanych w dokumencie.

Pod Pod konwersji może być przekształcona w różnych formatach, takich jak tekst, HTML, człowiek partii i tak dalej.

Pod znaczników składa się z trzech podstawowych podstawowe typy: zwykłe, oryginalne, i poleceń.

• pkt Normalny: Można użyć kodów formatowania w zwykłych punktach, takich jak pogrubienie, kursywa, lub stylu kodowania, podkreślenie.

• pkt oryginalny: fragmenty tekstu, dla części bloku kodu lub innego przetwarzania konwerter nie jest wymagany, ale nie wymaga paragraf przegrupowania.

• polecenie Akapit: Komenda Ustęp rola w całym dokumencie lub listy powszechnie używany do ustawiania title.

  Wszystkie akapity poleceń (jedyną jego długość przewodu) za pomocą "=" i potem jest identyfikatorem. Późniejsza tekst zostanie dotknięte niniejszego zarządzenia. Polecenie jest obecnie szeroko stosowane m.in.

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

W Perl, można użyć pod2html **. Pod> **. Html do generowania formatu saszetki dokumentu HTML.

POD Rozważmy następujące przykłady:

=begin html
=encoding utf-8

=head1 本教程

=cut

Kod ten będzie oryginałem, gdy pod2html.

Użyj pod2html wykonanie polecenia, aby przekształcić go do kodu HTML:

$ pod2html test.pod > test.html 

Otwórz test.html przeglądarki, linki sekcja dla indeksu znajduje się poniżej:

Poniższe przykłady są zapisywane bezpośrednio w HTML dokumentacji POD:

=begin html
=encoding utf-8

<h1>本教程</h1>
<p> www.w3big.com </p>

=end html

Kod ten będzie oryginałem, gdy pod2html.

Użyj pod2html wykonanie polecenia, aby przekształcić go do kodu HTML:

$ pod2html test.pod > test.html 

Otwórz test.html przeglądarki, linki sekcja dla indeksu znajduje się poniżej: