Acredito que quando as informações estão inseridas diretamente dentro do código o projeto fica mais robusto. Mas, e quanto ao uso dos clássicos comentários nos projetos? Tem alguma definição no PEP-8 em relação a uso de comentários para auxiliar no entendimento do código
Solucionado (ver solução)
Solucionado
(ver solução)
2
respostas
respostas
Uso de comentários
solução!
Olá, Leonardo.
Na verdade existe sim. O que o Guia de Estilo Para Python, disponibilizado pela comunidade Python Brasil, fala sobre comentários é:
Comentários
Comentários que contradizem o código são piores do que nenhum comentário. Sempre tenha como prioridade manter os comentários atualizados com as mudanças no código! Comentários devem sempre ser frases completas e sua primeira letra deve ser maiúscula, a menos que ele comece com um identificador que começa com uma letra minúscula.
Se um comentário for curto, o ponto final deve ser omitido. Comentários grandes normalmente consistem de um ou mais parágrafos e sentenças completas, estas sim devem terminar com ponto.
Você deve usar dois espaços depois do ponto final de uma frase, permitindo que o Emacs ajuste a linha de maneira consistente.
Programadores de países que não têm o inglês como língua nativa: escrevam seus comentários em inglês, a menos que você tenha 120% de certeza de que o código jamais será lido por pessoas que não falam sua língua.
Comentários em bloco devem ser indentados no mesmo nível do código a que se referem. Cada linha deve começar com # e um espaço (a menos que o texto dentro do comentário seja indentado). Parágrafos dentro de um bloco devem ser separados por uma linha contendo uma única tralha #. O bloco inteiro deve ser separado por uma linha em branco no topo e embaixo.
Comentários na mesma linha devem ser usados esporadicamente. Devem ser separados do comando por pelo menos dois espaços. Como outros comentários, devem começar com uma tralha e um espaço. Não faça comentários em coisas óbvias. Eles distraem mais do que ajudam.
Ademais, você também pode ler a documentação oficial sobre a PEP-8.
Espero ter ajudado.
Minha regra para uso de comentários é: nunca use.
Se o código que você fez precisa de algum comentário, quebre-o em partes menores de forma que fique claro sua intenção. Dessa forma, não precisará comentá-lo.
Um dos problemas dos comentários é que eles se tornam obsoletos muito rapidamente e passam a gerar confusão, pois ao modificar um código comentado não temos o costume de atualizar o comentário (ou verificar se ele continua refletindo a realidade do código).