3 มิถุนายน 2561

Published 6/03/2561 by with 0 comment

ลืมเอกสารของ Python ทำอย่างไร ?

หากผู้อ่านใช้ภาษา Python ไม่ว่าจะเป็นในการแข่งขันเขียนโปรแกรม หรือ ในห้องปฎิบัติการที่จำเป็นต้องเขียนโค้ดอย่างเร่งด่วน แต่กลับลืมเอกสารหรือ API ไลบารีของ Python ไป และ ไม่มีอินเทอร์เน็ตให้สืบค้น

แต่ในภาษา Python มีตัวช่วยในสถานะการนี้ นั้นคือ pydoc

pydoc เป็นระบบสร้างเอกสารจาก API ในตัวภาษา Python หากไลบารีหรือโมดูลนั้นสร้างเอกสาร API ตามหลักเอกสารของ Python สามารถใช้งานได้เลย
โดยใช้คำสั่ง $ pydoc ชื่อโมดูลหรือไลบารีที่ต้องการ

ตัวอย่างเช่น
ผมต้องการดูเอกสาร NumPy ผมสามารถใช้คำสั่ง $ pydoc numpy
แล้วจะขึ้นเอกสารของ NumPy ให้อ่านบนเทอร์มินัล

นอกจากนั้นยังสามารถใช้งานบน Web browser ได้โดยใช้คำสั่ง $ pydoc -p portที่ต้องการ
ตัวอย่าง
$ pydoc -p 1234
pydoc server ready at http://localhost:1234/
เมื่อคลิกเข้าไปที่ http://localhost:1234/ จะโชว์หน้าเอกสาร API ของภาษา Python
หน้าเอกสาร Python: Index of Modules
ซึ่งรวม API ของโมดูลต่าง ๆ ไว้ด้วย
หวังว่าบทความนี้คงมีประโยชน์ไม่มากก็น้อย

ขอบคุณครับ

0 ความคิดเห็น:

แสดงความคิดเห็น

แสดงความคิดเห็นได้ครับ :)