Article image
Luciano Rocha
Luciano Rocha30/11/2021 12:11
Share

Comentários: muitos falam quase ninguém pratica

  • #HTML

Fala devs como vão?

Estudando HTML5 e CSS3 com o professor Guanabara e pensei assim. Resolvi criar esse artigo porque a grande maioria falam mas quase ninguém faz: colocar comentários no código.

Minha opinião que devemos fazer código não para nós mesmo e sim para que os outros entendam (ou tentam entender).

É um pouco chato e cansativo no início que deve sempre comentar.

Mas com o passar do tempo, acaba sendo uma rotina.

Até para explicar para os outros anos depois certo?

E uma dica que dou, pelo eu acho: se você está quebrando a cabeça para criar aquela função, aquela página, que tal antes colocar o comentário e depois pensa no código?

Quando fiz projeto final na faculdade fiz isso e na grande maioria deu certo.

Essa dica independe de HTML, C#, Java, Python e outras. É só colocar que metade do seu problema será resolvido e se mais tarde voltar, não perde grande tempo de ter que ler todo o código para saber onde parou.

Share
Comments (2)
Fabrício Oliveira
Fabrício Oliveira - 09/09/2022 13:53

Excelente dica! Luciano. Fundamental colocar comentários nos codigos que desenvolvemos, afinal ajuda até mesmo nosso entendimento inicial.

Ricardo S.
Ricardo S. - 30/11/2021 16:21

Olá Luciano


Pode ser que isso aconteça pois essa questão é meio polêmica...

Quando estava na Facu, era orientado isso mesmo... que deveria comentar o código, para deixar registrado o que o código está fazendo e tal.... quando você está iniciando na programação... até é um conselho válido, para você fixar conceitos e tal...


Mas no livro Clean Code do Robest Martin, é colocado uma visão totalmente diferente e contrária a comentar o código com argumentos bem válidos...


Por exemplo, estes comentários que foram adicionados ao seu HTML poderia ser substituidos por tags semânticas da HTML5 para ficarem mais "Clean"..


Bons Estudos!