เอกสารของฟังก์ชันวางไว้ใน docstring (สตริงที่อยู่บรรทัดแรกของฟังก์ชัน)
หลักการเขียน Docstring
- บรรทัดแรก: สรุปวัตถุประสงค์สั้นๆ เริ่มต้นตัวพิมพ์ใหญ่ จบด้วยจุด ไม่ต้องระบุชื่อหรือชนิดของออบเจ็กต์
- บรรทัดที่สอง: เว้นบรรทัดว่าง เพื่อแยกสรุปจากรายละเอียด
- บรรทัดต่อไป: รายละเอียดเพิ่มเติม เช่น พารามิเตอร์ ค่าที่คืน ข้อยกเว้น ตัวอย่างการใช้งาน
Sphinx
Sphinx เป็นเครื่องมือสร้างเอกสารยอดนิยมสำหรับ Python แปลง reStructuredText เป็น HTML, PDF, man pages เป็นต้น Sphinx จะนำเข้าโค้ด ใช้ introspection ดึง signature และ docstring มาสร้างเอกสารอัตโนมัติ
