2
respostas

Há algum problema em fazer comentários inline após o código?

Há algum problema, como perda de eficiência, em fazer comentários inline após o código?

Ex.

print("Olar, mundo")    #  Dá "Olar" pro mundo.

Pergunto pois o pyCharm está possesso com meus comentários, mas eu gosto muito de tê-los ao lado do código e não gostaria de ter que passar a fazê-los nas linhas anteriores ao código, pois me atrapalha muito a ter uma boa fluidez e continuidade na leitura do código.

Se houver algum problema: existe alguma ferramenta que me permita fazer comentários fora do código, tal como o Word permite comentários em separado (aba "Revisão">Adicionar Comentário)? Alguma outra sugestão?

2 respostas

Fala Pedro, tudo bem?

Se o comentário descreve o que o código está fazendo, geralmente não é aconselhável incluir comentários, pode ser classificado como um "code-smell".

Em alguns casos, você pode estar usando técnicas que dificultam o entendimento do código. Nesses casos, os comentários podem e devem ser usados para não apenas explicar por que você tem essas lógicas complexas, mas o que o código está fazendo.

O mais importante, no entanto, é alterar seus comentários quando você altera seu código. Se você alterar um algoritmo, certifique-se de atualizar os comentários com o motivo pelo qual você usou o algoritmo X sobre Y. Os comentários antigos são um code-smell ainda maior.

No geral, se você está utilizando comentários para se orientar nos estudos, e isso te ajuda, continue utilizando-os.

Abraço!

Olá, Otávio! Tudo bem?

O exemplo utilizado é apenas para deixar claro o que seria um inline comment.

Os comentários que estou fazendo sempre apontam o tipo e o objetivo da variável que está sendo modificada ou usada como parâmetro naquela linha de código e o tipo e o objetivo da variável ou do valor que essa linha está resultando.

Ainda não faço códigos complexos o bastante para precisar me explicar sobre decisões questionáveis. Mas quando precisar, o farei.

A grande questão é sobre comentários em blocos ou na mesma linha (inline). O PEP8 me diz para evitar comentários na mesma linha, mas eu me sinto mais bem orientado quando uso esse tipo de comentário. Contudo, não quero que meus programas sejam um estorvo para quem quer que precise lê-los no futuro.

Como estou voltando a programar agora, quero adquirir bons hábitos e tenho ciência de que fazer bons comentários no seu código é essencial, por isso a preocupação.

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