Perl - perldoc - 記述

1.　記述

1.　記述

　ファイル名を「doc.pm」として、以下のようなソースを書いて


=encoding utf8

=head1 ヘッダ1

ヘッダ1なのだ

=head2 ヘッダ2

ヘッダ2なのだ

=head3 ヘッダ3

ヘッダ3なのだ

=head4 ヘッダ4

ヘッダ4なのだ

=cut



> perldoc doc.pm


　としましたらば、下記のように表示されます。

=encoding utf8


　は、ドキュメントのエンコードを定義しています。


=head1 ヘッダ1

ヘッダ1なのだ


　の箇所は実際のドキュメントの記述です。

　「HTML」の 「h1」～ 「h6」に対応しているらしく 「head1」～ 「head6」まで書けるらしいのですが・・・。わたしの環境では、「head5」、「head6」はエラーになりました。

　「headx」と 「headx」の間には、少なくとも１行以上の空行が必要です。


=cut


　はドキュメントの記述の終わりを示します。
　ドキュメントの記述は必ずこの行によって閉める必要があります。