Introdução

Os comentários são realmente muito úteis na programação se estiverem bem colocados. Mas na maioria das vezes os comentários não são tão “bons”.

Comentários ruins podem levar à desinformação, perda de tempo, criar maus hábitos, etc.

Neste artigo, vou orientá-lo sobre como evitar escrever comentários ruins

Comentários ruins

Comentários desatualizados

Comentários que ficaram antigos, obsoletos, irrelevantes ou fornecem informações erradas. Os comentários podem envelhecer muito rapidamente, porque a base de código pode mudar todos os dias, a tecnologia pode mudar todos os dias.

Como resolver:

• Atualize-o o mais rápido possível
• Apenas apague, na verdade

Gramática incorreta, muitos marcadores, murmúrios, plopping são apenas palavras mal escritas. De acordo com o código limpo, um comentário que vale a pena escrever vale a pena escrever bem. Se você for escrever um, reserve um tempo para poli-lo e escolha suas palavras com cuidado.

código comentado

Este é o pior tipo de comentário, eles me deixam louco toda vez que vejo um pedaço de código que foi comentado. Esse código não fez nada, eles ficaram lá e apodreceram. Mas ninguém sabe quando deletar porque “talvez alguém precise”

Como resolver isso? Apenas apague ! Hoje em dia o Git se tornou muito valioso, podemos encontrá-lo se alguém realmente precisar dele

comentários redundantes

Estes também são terríveis, vejam isto:

for(let i = 0; i < 10; i++){
  a = b // assign a to b
}

// a function returns sum of a and b
function sum(a, b){ return a + b}

Basta excluí -los.

Comentários barulhentos

Alguns comentários são apenas barulhentos. Você já viu algum comentário como esse?

// the name
private String name
// the version
private String version
// the constructor
constructor()

//The 123213 License
//
//Copyright (c)123213213213213, and Contributors
//
//Permission to use, copy, modify, and/or distribute this software for any
//purpose with or without fee is hereby granted, provided that the above
//copyright notice and this permission notice appear in all copies.
//
//THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
//WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
//MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
//ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
//WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
//ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
//IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Comentários HTML

Não há muito a dizer sobre isso, não acho que os comentários em HTML sejam úteis. Temos ID, nome de classe, nome de tag e milhares de outras maneiras de dizer o significado de um código. Por que se preocupar em escrever comentários para eles?

Conclusão

Embora alguns comentários sejam realmente necessários e benéficos, a maioria dos comentários não é. Eu sei que este artigo pode não ser tão positivo, mas eu só quero justificar isso:

Se o seu código estiver ruim, não comente, apenas limpe-o

No próximo artigo, escreverei sobre como escrever bons comentários, clique no botão seguir para conferir no futuro.

Obrigado por ler

Últimas palavras

Embora meu conteúdo seja gratuito para todos, mas se você achar este artigo útil, pode me pagar um café aqui