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:

pythondef getSum(num1, num2):
  'this function sums two numbers'
  return num1 + num2

La oss kalle help og finne ut hva som er kommentert i getSum:

pythonhelp(getSum)

Etter at koden er utført, vil en streng med funksjonens navn og dens dokumentasjon vises i konsollen:

pythonHelp 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:

pythonhelp(print)

For kun å skrive ut strengen med dokumentasjonen fra funksjonen, må du sende til help etter funksjonsnavnet den service konstruksjonen .__doc__:

pythonhelp(print.__doc__)