Utskrift av funksjonsdokumentasjon i Python
I funksjonskroppen kan du skrive en streng
som beskriver essensen av arbeidet som utføres. En slik
streng regnes som dokumentasjonen
for funksjonen. Den er omsluttet av enkle anførselstegn
og plasseres på første linje i funksjonskroppen.
For å lese den, må du bruke
en spesiell funksjon help, der parameteren
er funksjonens navn.
La oss si at vi har en funksjon som summerer to tall. En streng med tilsvarende informasjon er lagt igjen om dette:
def getSum(num1, num2):
'this function sums two numbers'
return num1 + num2
La oss kalle help og finne ut hva
som er kommentert i getSum:
help(getSum)
Etter at koden er utført, vil en streng med funksjonens navn og dens dokumentasjon vises i konsollen:
Help on function getSum in module __main__:
getSum(num1, num2)
this function sums two numbers
Med funksjonen help kan du lese
dokumentasjonen til standardfunksjoner også. La oss
få informasjon om funksjonen print:
help(print)
For kun å skrive ut strengen med
dokumentasjonen fra funksjonen, må du sende
til help etter funksjonsnavnet den service
konstruksjonen .__doc__:
help(print.__doc__)
Opprett en funksjon som tar imot en liste med månedsnavn som parameter og skriver dem ut med stor forbokstav. Beskriv essensen av funksjonens arbeid i dokumentasjonen og skriv den ut til konsollen.
Skriv ut all dokumentasjon om funksjonen sum.
Skriv ut kun strengen med dokumentasjon om
funksjonen len.