ภาษา Python คุณสามารถควบคุมคุณภาพโค้ดได้ด้วยการทำการทดสอบ (test) การทำงานของโค้ดด้วยไลบารี unittest
อ่านการทำการทดสอบ (test) โค้ดด้วยไลบารี unittest ได้ที่ วิธีการเขียน unittest ใน Python แบบลัด
ต่อไปคือการเขียนเอกสารการใช้งานของฟังก์ชัน หรือ คลาส
เอกสารถือเป็นสิ่งสำคัญสำหรับการพัฒนาโปรแกรม ถ้าไม่มีเอกสาร หากทำให้เกิดปัญหาหลายอย่างตามมา เช่น การบำรุงรักษาโปรแกรม , การพัฒนาต่อ เป็นต้น เพื่อป้องกันปัญหาดังกล่าว ทุกฟังก์ชันและคลาสควรมีเอกสารการใช้งานแนบติดไปกับโค้ดด้วย
ในการเขียนเอกสารในโค้ด Python ทำได้ใน
""" ใส่รายละเอียดอธิบายโค้ดลงไป ข้างล่างเป็นตัวอย่างการใช้งาน >>> ฟังก์ชั่น() 'ผลลัพธ์' """
หากเราต้องการทดสอบเอกสารทำได้ด้วยไลบารี doctest ตามตัวอย่างนี้
ตัวอย่าง
ผลลัพธ์
TestResults(failed=0, attempted=1)
หากใส่ตัวอย่างที่ผิดลงไปในเอกสาร
ผลลัพธ์
********************************************************************** File "1.py", line 7, in __main__.addition Failed example: addition(3,2) Expected: 6 Got: 5 ********************************************************************** 1 items had failures: 1 of 2 in __main__.addition ***Test Failed*** 1 failures. TestResults(failed=1, attempted=2)
อ่านเอกสาร doctest ได้ที่ https://docs.python.org/3/library/doctest.html
นอกจากนี้ Python มีเครื่องมือสำหรับตรวจสอบคุณภาพโค้ด Python คือ Pylint และ autopep8 เพื่อให้โค้ดเป็นไปตาม PEP8 ของ Python
ติดตามบทความต่อไปนะครับ
ขอบคุณครับ
0 ความคิดเห็น:
แสดงความคิดเห็น
แสดงความคิดเห็นได้ครับ :)