Docstring yazma
Az önce docstring'lerin faydaları hakkında biraz konuştuk. Bu egzersizde, Sphinx gibi bir dokümantasyon oluşturucu tarafından kullanılabilecek docstring'ler yazma pratiği yapacaksın.
Docstring yanıtının çözüme tam olarak uyması gerektiğini unutma. Birkaç kez yanlış yaparsan, örnek kodu yenileyip baştan başlaman iyi olabilir.
Bu egzersiz
Python'da Yazılım Mühendisliği İlkeleri
kursunun bir parçasıdırEgzersiz talimatları
- Parametreleri belgeleyen docstring kısımlarını tamamla.
- Dönen değeri açıklayan docstring kısmını tamamla.
- Docstring içindeki örnek fonksiyon kullanımını tamamla.
Uygulamalı interaktif egzersiz
Bu örnek kodu tamamlayarak bu egzersizi bitirin.
# 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)