Perl - Tài liệu được nhúng

Bạn có thể nhúng tài liệu Pod (Văn bản cũ thuần túy) vào các mô-đun và tập lệnh Perl của mình. Sau đây là quy tắc để sử dụng tài liệu nhúng trong Mã Perl của bạn:

Bắt đầu tài liệu của bạn bằng một dòng trống, a =head1 ở đầu lệnh và kết thúc bằng dấu =cut

Perl sẽ bỏ qua văn bản Pod mà bạn đã nhập trong mã. Sau đây là một ví dụ đơn giản về việc sử dụng tài liệu nhúng bên trong mã Perl của bạn:

#!/usr/bin/perl

print "Hello, World\n";

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

print "Hello, Universe\n";

Khi đoạn mã trên được thực thi, nó tạo ra kết quả sau:

Hello, World
Hello, Universe

Nếu bạn định đặt Pod của mình ở cuối tệp và bạn đang sử dụng dấu cắt __END__ hoặc __DATA__, hãy nhớ đặt một dòng trống ở đó trước lệnh Pod đầu tiên như sau, nếu không thì không có dòng trống trước cái =head1, nhiều người dịch sẽ không nhận ra =head1 khi bắt đầu một khối Pod.

#!/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";

Khi đoạn mã trên được thực thi, nó tạo ra kết quả sau:

Hello, World

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

Hãy lấy một ví dụ khác cho cùng một đoạn mã mà không cần đọc phần DATA -

#!/usr/bin/perl

print "Hello, World\n";

__END__

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

Khi đoạn mã trên được thực thi, nó tạo ra kết quả sau:

Hello, World

POD là gì?

Pod là một ngôn ngữ đánh dấu dễ sử dụng được sử dụng để viết tài liệu cho các chương trình Perl, Perl và mô-đun Perl. Có nhiều trình dịch khác nhau có sẵn để chuyển đổi Pod sang các định dạng khác nhau như văn bản thuần túy, HTML, trang người đàn ông, v.v. Đánh dấu nhóm bao gồm ba loại đoạn văn cơ bản -

Ordinary Paragraph - Bạn có thể sử dụng mã định dạng trong các đoạn văn thông thường, cho chữ in đậm, in nghiêng, kiểu mã, siêu liên kết, v.v.
Verbatim Paragraph - Các đoạn văn nguyên văn thường được sử dụng để trình bày một khối mã hoặc văn bản khác không yêu cầu bất kỳ phân tích cú pháp hoặc định dạng đặc biệt nào và không nên bao bọc.
Command Paragraph- Một đoạn lệnh được sử dụng để xử lý đặc biệt cho toàn bộ phần văn bản, thường là các tiêu đề hoặc các phần của danh sách. Tất cả các đoạn lệnh đều bắt đầu bằng =, theo sau là một mã định danh, theo sau là văn bản tùy ý mà lệnh có thể sử dụng theo cách thích hợp. Các lệnh hiện được công nhận là -

=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

Ví dụ về POD

Hãy xem xét POD sau -

=head1 SYNOPSIS
Copyright 2005 [TUTORIALSOPOINT].
=cut

Bạn có thể dùng pod2html tiện ích có sẵn trên Linux để chuyển đổi POD ở trên thành HTML, vì vậy nó sẽ tạo ra kết quả sau:

Tiếp theo, hãy xem xét ví dụ sau:

=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

Khi bạn chuyển đổi POD ở trên thành HTML bằng pod2html, nó sẽ tạo ra kết quả sau:

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.