หน้าแรก>บทช่วยสอนการเขียนโปรแกรมเครือข่าย>กวดวิชาภาษาเพิร์ล

เอกสาร Perl POD

ผู้เขียน：Eve Cole เวลาอัปเดต：2024-12-24 16:24:01

ในภาษา Perl เอกสาร POD (Plain Old Documentation) สามารถฝังลงในโมดูลหรือสคริปต์ได้

POD เป็นภาษามาร์กอัปที่เรียบง่ายและใช้งานง่าย (ภาษามาร์กอัป)

กฎการใช้เอกสาร POD:

เอกสาร POD เริ่มต้นด้วย =head1 และลงท้ายด้วย =cut เพิ่มบรรทัดว่างก่อน =head1 และหลัง =cut

Perl ละเว้นเอกสารใน POD ตัวอย่างมีดังนี้:

ตัวอย่าง

#!/usr/bin/perl พิมพ์ " สวัสดี ชาวโลก n " ; =head1 สวัสดี ชาวโลก ตัวอย่าง นี่คือตัวอย่าง Perl ง่ายๆ =ตัด พิมพ์ " สวัสดี Codercto n " ;

เมื่อรันโปรแกรมข้างต้น ผลลัพธ์ที่ได้คือ:

 สวัสดีชาวโลกสวัสดี Codercto

นอกจากนี้เรายังสามารถใช้ "__END__" หรือ "__DATA__" เพื่อ "แสดงความคิดเห็น" เนื้อหาทั้งหมดหลังบรรทัด:

ตัวอย่าง

#!/usr/bin/perl พิมพ์ " สวัสดีชาวโลก n " ; ในขณะที่ ( < DATA > ) { พิมพ์ $ _ ; __จบ__ =head1 สวัสดี ตัวอย่างของโลก นี่เป็นตัวอย่างง่ายๆ ของ Perl พิมพ์ "สวัสดี Codercton";

เมื่อรันโปรแกรมข้างต้น ผลลัพธ์ที่ได้คือ:

 สวัสดี World=head1 สวัสดี ตัวอย่างโลก นี่คือตัวอย่าง Perl ง่ายๆ พิมพ์ "สวัสดี Codercton";

ตัวอย่างต่อไปนี้ไม่ได้อ่านเอกสาร POD:

ตัวอย่าง

#!/usr/bin/perl พิมพ์ " สวัสดีชาวโลก n " ; =head1 สวัสดี ตัวอย่างของโลก นี่เป็นตัวอย่างง่ายๆ ของ Perl พิมพ์ "สวัสดี Codercton";

เมื่อรันโปรแกรมข้างต้น ผลลัพธ์ที่ได้คือ:

 สวัสดีชาวโลก

พ็อดคืออะไร?

Pod (Plain Old Documentation) เป็นภาษามาร์กอัปที่เรียบง่ายและใช้งานง่าย (ภาษามาร์กอัป) ซึ่งมักใช้สำหรับการเขียนเอกสารในโปรแกรมและโมดูล Perl

ตัวแปลง Pod สามารถแปลง Pod เป็นรูปแบบต่างๆ ได้มากมาย เช่น ข้อความ, html, man เป็นต้น

ภาษามาร์กอัป Pod มีประเภทพื้นฐานสามประเภท: ปกติ ข้อความ และคำสั่ง

ย่อหน้าธรรมดา : คุณสามารถใช้โค้ดการจัดรูปแบบในย่อหน้าทั่วไป เช่น ตัวหนา ตัวเอียง หรือลักษณะโค้ด การขีดเส้นใต้ ฯลฯ

ย่อหน้าต้นฉบับ : ย่อหน้าต้นฉบับ ใช้สำหรับบล็อกโค้ดหรือส่วนอื่นๆ ที่ไม่ต้องการการประมวลผลตัวแปลง และไม่จำเป็นต้องจัดเรียงย่อหน้าใหม่

ย่อหน้าคำสั่ง : ย่อหน้าคำสั่งจะมีผลกับเอกสารทั้งหมด และมักใช้สำหรับตั้งชื่อเรื่องหรือมาร์กอัปรายการ

ย่อหน้าคำสั่งทั้งหมด (ซึ่งมีความยาวเพียงบรรทัดเดียว) เริ่มต้นด้วย "=" ตามด้วยตัวระบุ ข้อความต่อมาจะได้รับผลกระทบจากคำสั่งนี้ คำสั่งที่ใช้กันอย่างแพร่หลายในปัจจุบันได้แก่

 =pod (เอกสารเริ่มต้น)=ข้อความชื่อเรื่อง head1=ข้อความชื่อเรื่อง head2=ข้อความชื่อเรื่อง head3=ข้อความชื่อเรื่อง head4=จำนวนช่องว่างที่เยื้องเกิน=คำนำหน้ารายการ=ด้านหลัง (รายการสิ้นสุด)=รูปแบบเอกสารเริ่มต้น=รูปแบบเอกสารท้ายสุด=สำหรับรูปแบบข้อความ =การเข้ารหัส ประเภทการเข้ารหัส=ตัด (ส่วนท้ายของเอกสาร)

ในภาษา Perl คุณสามารถใช้ pod2html **.pod >**.html เพื่อสร้างเอกสาร pod ในรูปแบบ html

พิจารณาอินสแตนซ์ POD ต่อไปนี้:

ตัวอย่าง

=เริ่มต้น html=การเข้ารหัส utf-8 =head1 โปรแกรมเมอร์สอน =cut

เมื่อใช้ pod2html โค้ดนี้จะถูกคัดลอกจากข้อความต้นฉบับ

ใช้คำสั่ง pod2html เพื่อดำเนินการและแปลงเป็นโค้ด HTML:

 $ pod2html test.pod > test.html

เปิด test.html ในเบราว์เซอร์ ส่วนลิงก์คือดัชนี ดังที่แสดงด้านล่าง:

ตัวอย่างต่อไปนี้เขียน HTML โดยตรงในเอกสาร POD:

 =begin html=encoding utf-8<h1>บทช่วยสอนการเขียนโค้ด</h1><p> www.codercto.com </p>=end html

เมื่อใช้ pod2html โค้ดนี้จะถูกคัดลอกจากข้อความต้นฉบับ

ใช้คำสั่ง pod2html เพื่อดำเนินการและแปลงเป็นโค้ด HTML:

 $ pod2html test.pod > test.html

เปิด test.html ในเบราว์เซอร์ ส่วนลิงก์คือดัชนี ดังที่แสดงด้านล่าง:

บทความที่เกี่ยวข้อง