Uma das características únicas da linguagem de programação Python é a capacidade do programador para acessar diretamente a documentação para uma classe ou função. Enquanto a classe ou função tem um definido " docstring ", um comentário especialmente formatado , o desenvolvedor pode acessá-lo em qualquer ponto do seu programa ou o interpretador Python . Instruções
1
Abra o interpretador Python ou um arquivo de programa Python existente
2
Digite o seguinte para definir uma docstring : .
Def foo :
"" " Esta é a docstring python para a classe " foo " . " ""
Substitua o " " pressionando a tecla tab ou entrando em alguns espaços .
3 Digite o seguinte para acessar o docstring :
foo.__doc__
Isso pode ser feito por qualquer classe ou método adequadamente definidos em Python. Por exemplo, para ver o docstring para a classe String embutido , tipo :
str.__doc__