Documentatie van functies weergeven in Python
In de body van een functie kan een string worden geschreven,
die de essentie van het uitgevoerde werk beschrijft. Zo'n
string wordt beschouwd als de documentatie van de
functie. Het wordt tussen enkele aanhalingstekens geplaatst
en bevindt zich op de eerste regel van de functiebody.
Om het te lezen, moet je een speciale functie
help gebruiken, waarbij de naam van de functie wordt doorgegeven aan de parameter.
Stel dat we een functie hebben die twee getallen optelt. Hierover is een string met de overeenkomstige informatie achtergelaten:
def getSum(num1, num2):
'this function sums two numbers'
return num1 + num2
Laten we help aanroepen en ontdekken wat
er is gecommentarieerd in getSum:
help(getSum)
Na het uitvoeren van de code verschijnt er een string met de functienaam en de documentatie in de console:
Help on function getSum in module __main__:
getSum(num1, num2)
this function sums two numbers
Met de functie help kan je ook
de documentatie van standaardfuncties lezen. Laten we
informatie opvragen over de functie print:
help(print)
Om alleen de documentatiestring uit de functie weer te geven,
moet je na de functienaam in help de speciale
constructie .__doc__ doorgeven:
help(print.__doc__)
Maak een functie die een lijst met namen van maanden als parameter accepteert en deze met een hoofdletter weergeeft. Beschrijf de essentie van de werking van de functie in de documentatie en geef deze weer in de console.
Geef alle documentatie weer over de functie sum.
Geef alleen de documentatiestring weer over
de functie len.
