แนะนำตัว
pydoc โมดูลสร้างเอกสารโดยอัตโนมัติจากโมดูล Python สามารถบันทึกเอกสารเป็นหน้าข้อความบนคอนโซล แสดงบนเว็บเบราว์เซอร์ หรือแม้แต่เป็นไฟล์ HTML
ในบทความนี้ คุณจะได้เรียนรู้วิธีการดูเอกสารเหล่านี้ในกรณีต่างๆ และแม้กระทั่งเรียนรู้เกี่ยวกับเอกสารที่ช่วยคุณสร้างเอกสารของคุณเองสำหรับสคริปต์หลามของคุณ
เมื่อคุณรู้จักการใช้ pydoc แล้ว เรามาเริ่มกันเลย
เริ่มต้นใช้งาน
โมดูล pydoc มาพร้อมกับ Python ซึ่งหมายความว่าคุณไม่จำเป็นต้องดาวน์โหลดและติดตั้งแยกต่างหาก
ในการเข้าถึง pydoc คุณต้องนำเข้าก่อน
import pydoc
การเข้าถึงเชลล์แบบโต้ตอบโดยใช้ฟังก์ชัน help()
คุณสามารถเข้าถึงเชลล์แบบโต้ตอบใน pydoc ได้โดยใช้ฟังก์ชันความช่วยเหลือ
ในการดำเนินการนี้ ให้เปิดเทอร์มินัลแล้วป้อนเชลล์แบบโต้ตอบของหลาม
ตอนนี้ นำเข้า pydoc แล้วใช้คำสั่ง pydoc.help() เพื่อเรียกใช้เชลล์แบบโต้ตอบ
ตัวอย่าง
>>>import pydoc >>>pydoc.help()
ตอนนี้คุณสามารถป้อนชื่อของโมดูล ประเภทข้อมูล ฟังก์ชัน คลาส ฯลฯ เพื่อรับเอกสารประกอบได้จากสคริปต์โต้ตอบ
การดูเอกสารจากเบราว์เซอร์
หากคุณต้องการดูเอกสารจากเบราว์เซอร์ คุณสามารถทำได้ง่ายๆ โดยใช้ pydoc
คราวนี้คุณไม่จำเป็นต้องรันคำสั่งผ่าน python shell แต่คุณสามารถให้อาร์กิวเมนต์และเปิดใช้งานได้โดยตรง
โดยเปิดเทอร์มินัลแล้วพิมพ์คำสั่งด้านล่าง
python −m pydoc −b
สิ่งนี้ควรสร้างเอกสารสำหรับโมดูล ฟังก์ชัน และอ็อบเจ็กต์ของ python ทั้งหมดที่มีอยู่ในระบบภายในของคุณบนเบราว์เซอร์
คุณยังค้นหาและเรียกคีย์เวิร์ดที่ต้องการได้ด้วยวิธีนี้
C:\Users\vijay>python −m pydoc −b Server ready at https://localhost:50621/ Server commands: [b]rowser, [q]uit server> q Server stopped
การทำงานกับเอกสาร
ตัวอย่าง
def documentation(): '''Documentation using docstrings''' print(documentation.__doc__) help(documentation)
ผลลัพธ์
Documentation using docstrings Help on function documentation in module __main__: documentation() Documentation using docstrings
บทสรุป
ตอนนี้คุณทราบวิธีดูและอ่านเอกสารของคีย์เวิร์ด ฟังก์ชัน โมดูล วิธีการต่างๆ ของ python แบบออฟไลน์แล้วโดยใช้ฟังก์ชัน pydoc
คุณยังได้เรียนรู้วิธีสร้างและสร้างเอกสารของคุณเองโดยใช้เอกสารประกอบ
จำเป็นอย่างยิ่งที่จะต้องรักษาเอกสารที่ดีในขณะที่ทำงานในโครงการขนาดใหญ่ เพื่อที่จะรู้ว่าคุณกำลังทำอะไรอยู่ที่ไหนและหลีกเลี่ยงความสับสนในอนาคต นอกจากนี้ยังช่วยป้องกันข้อผิดพลาดที่ไม่รู้จักหรือรันไทม์ต่างๆ อีกด้วย
