เริ่มต้นใช้งานเริ่มต้นใช้งานได้ฟรี

การเขียน docstring

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

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

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

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

ดูคอร์ส

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

  • เติมส่วนของ docstring ที่ใช้อธิบาย parameter แต่ละตัว
  • เติมส่วนของ docstring ที่อธิบายค่าที่ฟังก์ชันคืนกลับมา
  • เติมตัวอย่างการใช้งานฟังก์ชันใน docstring ให้ครบถ้วน

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

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

# Complete the function's docstring
def tokenize(text, regex=r'[a-zA-z]+'):
  """Split text into tokens using a regular expression

  :____ text: text to be tokenized
  :param ____: regular expression used to match tokens using re.findall 
  :____: a list of resulting tokens

  >>> ____('the rain in spain')
  ____
  """
  return re.findall(regex, text, flags=re.IGNORECASE)

# Print the docstring
help(tokenize)
แก้ไขและรันโค้ด