Funktion dokumentaation näyttäminen Pythonissa

Funktion sisällä voit kirjoittaa merkkijonon, joka kuvaa suoritettavan työn ydintä. Tällaista merkkijonoa pidetään yleisesti funktion dokumentaationa. Se on yksittäisten lainausmerkkien sisällä ja sijoitetaan funktion rungon ensimmäiselle riville. Lukeaksesi sen, sinun on käytettävä erityistä funktiota help, jonka parametriin annetaan funktion nimi.

Oletetaan, että meillä on funktio, joka laskee kahden luvun summan. Tästä on jätetty rivi vastaavilla tiedoilla:

pythondef getSum(num1, num2):
  'tämä funktio laskee kahden luvun summan'
  return num1 + num2

Kutsutaan help ja selvitetään, mitä on kommentoitu funktioon getSum:

pythonhelp(getSum)

Koodin suorittamisen jälkeen konsoliin ilmestyy rivi funktion nimellä ja sen dokumentaatiolla:

pythonHelp on function getSum in module __main__:

getSum(num1, num2)
  tämä funktio laskee kahden luvun summan

Funktiolla help voit lukea dokumentaatiota myös vakiofunktioista. Selvitetään tietoa funktiosta print:

pythonhelp(print)

Jos haluat tulostaa vain dokumentaatiomerkkijonon funktiosta, sinun on annettava help-funktiolle funktion nimen jälkeen palvelun rakennus .__doc__:

pythonhelp(print.__doc__)