Pular para o conteúdo principal

Tutorial de docstrings em Python

Saiba mais sobre os Docstrings do Python. Encontre diferentes exemplos e tipos de formatos de docstrings para Sphinx, Numpy e Pydoc.
· 15 min leer

Explore com IA

Execute e edite o código deste tutorial online

Executar código

Se você está apenas começando a usar Python e gostaria de saber mais, faça o curso Introdução à ciência de dados em Python do DataCamp.

Pratique Docstrings em Python com este exercício prático.

A string de documentação do Python, ou comumente conhecida como docstring, é um literal de string e é usada na definição de classe, módulo, função ou método. Você pode acessar os docstrings no atributo doc (__doc__) para qualquer um dos objetos Python e também com a função integrada help(). A docstring de um objeto é definida pela inclusão de uma constante de string como a primeira instrução na definição do objeto.

Os docstrings são ótimos para você entender a funcionalidade da maior parte do código, ou seja, a finalidade geral de qualquer classe, módulo ou função, enquanto os comentários são usados para códigos, declarações e expressões, que tendem a ser pequenos. São textos descritivos escritos por um programador, principalmente para que ele próprio saiba o que a linha de código ou expressão faz e também para o desenvolvedor que deseja contribuir com esse projeto. É essencial que você documente seu código Python para que possa escrever um código limpo e programas bem escritos.

Os docstrings ajudam você a entender os recursos de um módulo ou de uma função. Por exemplo, digamos que você tenha instalado a biblioteca scikit-learn e queira saber tudo sobre o pacote sklearn, como descrição, módulos do pacote etc., você pode simplesmente usar a função help para obter todas as informações.

Vamos importar o pacote rapidamente.

import sklearn
help(sklearn)