การแสดงผลเอกสารประกอบฟังก์ชันใน Python

ในเนื้อความของฟังก์ชันสามารถเขียนสตริงบรรทัดหนึ่งเพื่ออธิบายสาระสำคัญของงานที่ทำ สตริงดังกล่าวถือเป็นเอกสารประกอบของฟังก์ชัน โดยจะอยู่ในเครื่องหมายคำพูดเดี่ยวและวางไว้ในบรรทัดแรกของเนื้อความฟังก์ชัน หากต้องการอ่านเอกสารนี้ต้องใช้ฟังก์ชันพิเศษ help ซึ่งรับพารามิเตอร์เป็นชื่อฟังก์ชัน

สมมติว่าเรามีฟังก์ชันที่บวกตัวเลขสองตัว และได้ใส่สตริงที่มีข้อมูลนี้ไว้แล้ว:

pythondef getSum(num1, num2):
  'ฟังก์ชันนี้ใช้บวกตัวเลขสองตัว'
  return num1 + num2

ลองเรียกใช้ help เพื่อดูว่ามีอะไรถูกคอมเมนต์ไว้ใน getSum:

pythonhelp(getSum)

หลังจากรันโค้ดแล้ว ในคอนโซลจะปรากฏสตริงที่มีชื่อฟังก์ชันและเอกสารประกอบ:

pythonHelp on function getSum in module __main__:

getSum(num1, num2)
  ฟังก์ชันนี้ใช้บวกตัวเลขสองตัว

สามารถใช้ฟังก์ชัน help ในการอ่านเอกสารประกอบของฟังก์ชันมาตรฐานได้ ลองดูข้อมูลเกี่ยวกับฟังก์ชัน print:

pythonhelp(print)

หากต้องการแสดงเฉพาะสตริงเอกสารประกอบจากฟังก์ชัน ต้องส่งโครงสร้างบริการ .__doc__ หลังชื่อฟังก์ชันเข้าไปใน help:

pythonhelp(print.__doc__)