Die uitvoer van funksiedokumentasie in Python

In die liggaam van 'n funksie kan jy 'n string plasing wat die wese van die uitgevoerde werk beskryf. So 'n string word algemeen beskou as die dokumentasie van die funksie. Dit word tussen enkelkwotasies geplaas en in die eerste reël van die funksieliggaam gesit. Om dit te lees, moet jy die spesiale funksie help gebruik, waar die naam van die funksie as parameter oorgedra word.

Gestel ons het 'n funksie wat twee getalle optel. Daar is 'n string gelaat met die ooreenstemmende inligting daaroor:

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

Kom ons roep help en vind uit wat in getSum gekommentaar is:

help(getSum)

Na die uitvoering van die kode sal 'n string met die naam van die funksie en sy dokumentasie in die konsole verskyn:

Help on function getSum in module __main__:

getSum(num1, num2)
	this function sums two numbers

Met die help funksie kan jy ook die dokumentasie van standaard funksies lees. Kom ons vind inligting oor die print funksie:

help(print)

Om slegs die dokumentasiestring van die funksie uit te voer, moet jy na die funksienaam in help die dienskonstruksie .__doc__ oordra:

help(print.__doc__)

Skep 'n funksie wat 'n lys van maandname as parameter sal neem en hulle met 'n hoofletter sal uitvoer. Beskryf die wese van die funksie se werk in die dokumentasie en voer dit in die konsole uit.

Voer al die dokumentasie oor die sum funksie uit.

Voer slegs die dokumentasiestring oor die len funksie uit.