Perl POD 문서

Perl은 모듈이나 스크립트에 POD(Plain Old Documentation) 문서를 삽입할 수 있습니다.

POD는 간단하고 사용하기 쉬운 마크업 언어(Markup Language)입니다.

POD 문서 사용 규칙:

POD 문서는 =head1으로 시작하고, =cut은 =head1로 끝납니다<🎜 =cut 앞뒤에 빈 줄을 추가하세요.

Perl은 POD의 문서를 무시합니다. 예는 다음과 같습니다:

#!/usr/bin/perl

print "Hello, World\n";

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

print "Hello, php\n";

위 프로그램을 실행하면 출력 결과는 다음과 같습니다.

Hello, World
Hello, php

또한 "__END__" 또는 "__DATA__"를 사용하여 이후의 모든 내용을 "주석 처리"할 수 있습니다. 줄:

#!/usr/bin/perl

print "Hello, World\n";

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

__END__

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

위 프로그램을 실행하면 출력 결과는 다음과 같습니다.

Hello, World

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

다음 예는 POD 문서를 읽지 않습니다.

#!/usr/bin/perl

print "Hello, World\n";

__END__

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

위 프로그램을 실행합니다. 출력 결과는 다음과 같습니다.

Hello, World

---

POD란 무엇인가요?

Pod(Plain Old Documentation)는 간단하고 사용하기 쉬운 마크업 언어(마크업 언어)로 Perl 프로그램 및 모듈에서 문서 작성에 자주 사용됩니다.

Pod의 변환기는 Pod를 텍스트, html, man 등의 다양한 형식으로 변환할 수 있습니다.

Pod 마크업 언어에는 일반, 원본, 명령의 세 가지 기본 유형이 포함되어 있습니다.

• 일반 단락: 일반 단락에서 볼드체, 이탤릭체, 코드 스타일, 밑줄 등 서식 지정 코드를 사용할 수 있습니다.

• 원본 문단: 원본 문단, 코드 블록이나 변환기 처리가 필요하지 않은 기타 부분에 사용되며 문단 재배열이 필요하지 않습니다.

• 명령 단락 : 명령 단락은 전체 문서에 적용되며 일반적으로 제목 설정이나 목록 마크업에 사용됩니다.

  모든 명령 단락(단 한 줄 길이)은 "="로 시작하고 그 뒤에 식별자가 옵니다. 후속 텍스트는 이 명령의 영향을 받습니다. 이제 널리 사용되는 명령에는

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

가 포함됩니다. Perl에서는 pod2html **.pod >**.html을 사용하여 html 형식의 Pod 문서를 생성할 수 있습니다.

다음 POD 예를 고려하세요.

=begin html
=encoding utf-8

=head1 php中文网

=cut

pod2html을 사용하면 이 코드가 원본 텍스트에서 복사됩니다.

pod2html 명령을 사용하여 실행하고 HTML 코드로 변환합니다:

$ pod2html test.pod > test.html

브라우저에서 test.html을 엽니다. 아래와 같이 링크 부분이 인덱스입니다.

다음 예에서는 HTML을 POD 문서에 직접 작성합니다.

=begin html
=encoding utf-8

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

=end html

pod2html은 이 코드의 원본 텍스트를 복사합니다.

pod2html 명령을 사용하여 실행하고 HTML 코드로 변환합니다.

$ pod2html test.pod > test.html

브라우저에서 test.html을 엽니다. 링크 부분은 아래와 같이 인덱스입니다.