Docstrings เป็นตัวช่วยที่สำคัญตัวนึงเลยสำหรับผม อันนี้เคยไปดูมาจาก Youtube ช่องนึงมา ใครขี้เกียจอ่านก็กด Link ไปดูได้เลยครับ
เริ่มจาก Docstrings คืออะไร
ถ้าให้ผมอธิบายมันก็จะเป็นเหมือน comment หลายบันทัดแหละ แต่ผมจะไม่ได้ใช้งานแบบนั้นเท่าไหร่ เพราะผมใช้ # ในการ comment หมดเลย แล้วด ใช้ Docstrings ในการอธิบายการทำงานของ function ที่เขียนขึ้นมา โดยโครงสร้างก็จะประมาณใช้ double code 3 ตัวเปิด แล้วก็อีก 3 ปิดท้าย
"""อธิบายการทำงานของ function
Args input มีอะไรบ้าง type เป็นอะไร พร้อมคำอธิบายนิดหน่อย
Return มี type เป็นอะไร แล้วก็คำอธิบายนิดหน่อย
"""
ผมใช้ vs-code เป็นหลัก ก็จะมี extendtion ตัวนึงที่ทำงานร่วมกับ Docstrings คือตัวนี้
ไปที่กล้องสี่เหลี่ยมแตกๆด้านซ้ายนะครับ มันคือ extendtion ของ vs-code แล้ว search docstring ได้เลย
ติดตั้งไอตัวเขียวๆเหมือนในรูปนี้แหละ
เวลาใช้งานก็ เขียน function ให้เสร็จก่อน ไปที่ด้านบน ใต้ def แล้วพิมพ์ double code 3 ตัว มันก็จะขึ้นอันนี้มาให้
คือมีตัวแปรให้หมดเลย เราก็ไปใส่คำอธิบายกับ type เอา ถ้าเรายังเขียนไม่เสร็จ มันก็จะไม่มีพวกนี้ขึ้นมาให้นะ
หลังจากแก้เสร็จของผมก็จะหน้าตาประมาณนี้
เวลาเรียกใช้ ก็จะมีคำอธิบายตามที่เขียนไว้ให้เลย ตัวอย่างก็ประมาณนี้
ไม่มีความคิดเห็น:
แสดงความคิดเห็น