Solucionado (ver solução)
Solucionado
(ver solução)
2
respostas

Dúvida sobre docstring

Por que usar aspas triplas e não # para docstring?

2 respostas

As aspas triplas (""") são usadas em Python para criar docstrings, elas são strings de documentação usadas para documentar funções, classes, métodos ou módulos, o uso do símbolo "#" é útil para comentar o código e fornecer explicações breves em uma única linha, as aspas triplas são mais adequadas e recomendadas para criar docstrings mais detalhadas e estruturadas,

solução!

Olá, Anderson! Tudo bem?

As docstrings em Python são uma forma de documentação incorporada ao código. Elas são colocadas logo após a definição de uma função, método, classe ou módulo, entre aspas triplas ("""), e não com o símbolo de comentário (#).

A principal diferença entre docstrings e comentários é que as docstrings são armazenadas no atributo doc do objeto e são acessíveis a partir do código em tempo de execução. Isso significa que você pode acessar a documentação de uma função, por exemplo, diretamente do código.

Além disso, ferramentas de geração de documentação como Sphinx podem automaticamente extrair docstrings para produzir documentação externa.

Vamos a um exemplo prático:

def soma(a, b):
    """
    Esta função soma dois números.
    
    Args:
        a (int): O primeiro número a ser somado.
        b (int): O segundo número a ser somado.
    
    Returns:
        int: A soma dos dois números.
    """
    return a + b

print(soma.__doc__)

Ao executar esse código, você verá que a saída será a string de documentação que definimos para a função soma. Isso não seria possível com um comentário regular.

Espero ter ajudado e bons estudos!

Quer mergulhar em tecnologia e aprendizagem?

Receba a newsletter que o nosso CEO escreve pessoalmente, com insights do mercado de trabalho, ciência e desenvolvimento de software