เอกสารและการทดสอบในทางปฏิบัติ

หลักการวิศวกรรมซอฟต์แวร์ใน Python

Adam Spannbauer

Machine Learning Engineer at Eastman

จัดทำเอกสารโปรเจกต์ด้วย Sphinx

  ตัวอย่างหน้า Sphinx

หลักการวิศวกรรมซอฟต์แวร์ใน Python

การจัดทำเอกสารคลาส

class Document:
    """Analyze text data

    :param text: text to analyze

    :ivar text: text originally passed to the instance on creation
    :ivar tokens: Parsed list of words from text
    :ivar word_counts: Counter containing counts of hashtags used in text
    """
    def __init__(self, text):
        ...
หลักการวิศวกรรมซอฟต์แวร์ใน Python

การทดสอบแบบ Continuous Integration

    โลโก้ Travis CI

ตัวอย่างผลลัพธ์ Travis - ล้มเหลว

หลักการวิศวกรรมซอฟต์แวร์ใน Python

การทดสอบแบบ Continuous Integration

  ตัวอย่างผลลัพธ์ Travis - ผ่าน

หลักการวิศวกรรมซอฟต์แวร์ใน Python

ลิงก์และเครื่องมือเพิ่มเติม

  • Sphinx - สร้างเอกสารที่สวยงาม
  • Travis CI - ทดสอบโค้ดอย่างต่อเนื่อง
  • GitHub & GitLab - โฮสต์โปรเจกต์ด้วย git
  • Codecov - ค้นหาจุดที่ควรเพิ่มการทดสอบ
  • Code Climate - วิเคราะห์โค้ดเพื่อปรับปรุงความอ่านง่าย
หลักการวิศวกรรมซอฟต์แวร์ใน Python

มาฝึกกันเถอะ!

หลักการวิศวกรรมซอฟต์แวร์ใน Python

Preparing Video For Download...