Exibindo a documentação de funções em Python
No corpo de uma função, você pode escrever uma string
descrevendo a essência do trabalho realizado. Essa
string é considerada a documentação da
função. Ela é colocada entre aspas simples
e posicionada na primeira linha do corpo da função.
Para lê-la, você precisa usar a
função especial help, passando o nome da função
como parâmetro.
Suponha que temos uma função que soma dois números. Uma string com a informação correspondente foi deixada como documentação:
def getSum(num1, num2):
'this function sums two numbers'
return num1 + num2
Vamos chamar help e descobrir o que
foi documentado em getSum:
help(getSum)
Após executar o código, aparecerá no console uma string com o nome da função e sua documentação:
Help on function getSum in module __main__:
getSum(num1, num2)
this function sums two numbers
Com a função help você também pode ler
a documentação de funções padrão. Vamos
descobrir informações sobre a função print:
help(print)
Para exibir apenas a string de
documentação da função, você precisa passar
para help, após o nome da função, a construção
de serviço .__doc__:
help(print.__doc__)
Crie uma função que receba uma lista de nomes de meses como parâmetro e os exiba com a primeira letra maiúscula. Descreva a essência do funcionamento da função na documentação e exiba-a no console.
Exiba toda a documentação sobre a função sum.
Exiba apenas a string de documentação sobre a
função len.
