Olá, Matheus! Tudo bem?
Sua pergunta é muito relevante e mostra que você está pensando criticamente sobre as melhores práticas de codificação.
As docstrings em Python são uma forma de documentação incorporada ao código. Elas são diferentes dos comentários, pois são mais estruturadas e têm um propósito específico.
Agora, quanto à sua preocupação sobre as docstrings se tornarem desatualizadas ou sem sentido, é uma preocupação válida. Assim como qualquer forma de documentação, as docstrings precisam ser mantidas e atualizadas à medida que o código evolui. No entanto, como as docstrings estão diretamente associadas ao código que documentam, há uma maior probabilidade de que sejam mantidas atualizadas em comparação com a documentação externa.
Na prática, o uso de docstrings varia de empresa para empresa e de equipe para equipe. Algumas equipes podem exigir que todas as funções e métodos tenham docstrings, enquanto outras podem não ter essa exigência. No entanto, é uma boa prática incluir docstrings, especialmente para funções e métodos que não são imediatamente óbvios em seu propósito.
Espero ter ajudado e bons estudos!
Caso este post tenha lhe ajudado, por favor, marcar como solucionado ✓.
