Docstring (napis w potrójnych cudzysłowach zaraz pod def) staje się częścią funkcji: jest dostępny przez help() i funkcja.__doc__, a edytory pokazują go w podpowiedziach. Komentarz # widzi tylko ktoś, kto czyta kod źródłowy.
Docstring opisuje, co funkcja robi i jak jej używać. Komentarze w środku tłumaczą dlaczego coś zrobiono tak, a nie inaczej.
Komentarze 4
Dołącz do dyskusji SkomentujMasz już konto? Zaloguj się
Docstring (napis w potrójnych cudzysłowach zaraz pod
def) staje się częścią funkcji: jest dostępny przezhelp()ifunkcja.__doc__, a edytory pokazują go w podpowiedziach. Komentarz#widzi tylko ktoś, kto czyta kod źródłowy.Docstring opisuje, co funkcja robi i jak jej używać. Komentarze w środku tłumaczą dlaczego coś zrobiono tak, a nie inaczej.
Czyli docstring jest dla użytkownika funkcji. Dzięki!
Wyzwanie "Docstring and type hints" fajnie to ćwiczy.
Też dopiero niedawno zacząłem pisać docstringi, a edytor od razu podpowiada lepiej.