การเขียน Docstring สำหรับคลาสด้วย Sphinx

sphinx เป็นเครื่องมือที่ยอดเยี่ยมสำหรับการเรนเดอร์เอกสารให้เป็น HTML ในแบบฝึกหัดนี้ จะได้เขียน docstring สำหรับคลาส เพื่อให้ sphinx นำไปใช้งานได้

โปรดทราบว่าคำตอบของ docstring ต้องตรงกับเฉลยทุกประการ หากทำผิดหลายครั้ง ลองรีเซ็ตเป็นโค้ดตัวอย่างแล้วเริ่มใหม่อีกครั้ง

แบบฝึกหัดนี้เป็นส่วนหนึ่งของหลักสูตร

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

ดูคอร์ส

คำแนะนำการฝึกหัด

import คลาส Document from แพ็กเกจ text_analyzer เพื่อนำมาใช้ในนิยามคลาส
เติมบรรทัดของ docstring ที่เกี่ยวกับพารามิเตอร์ของเมธอด __init__ ให้ครบถ้วน
เติม docstring ให้สมบูรณ์โดยกรอกเอกสารสำหรับแอตทริบิวต์หรือ 'instance variables' ของคลาส SocialMedia

แบบฝึกหัดเชิงโต้ตอบแบบลงมือทำ

ลองทำแบบฝึกหัดนี้โดยเติมโค้ดตัวอย่างนี้ให้สมบูรณ์

____

class SocialMedia(Document):
    """Analyze text data from social media
    
    ____ social media text to analyze

    :____: Counter object containing counts of hashtags used in text
    :____: Counter object containing counts of @mentions used in text
    """
    def __init__(self, text):
        Document.__init__(self, text)
        self.hashtag_counts = self._count_hashtags()
        self.mention_counts = self._count_mentions()

แก้ไขและรันโค้ด