{"id":2656,"date":"2020-04-14T18:15:00","date_gmt":"2020-04-14T21:15:00","guid":{"rendered":"https:\/\/www.ufsm.br\/pet\/sistemas-de-informacao\/?p=2656"},"modified":"2025-09-02T13:56:47","modified_gmt":"2025-09-02T16:56:47","slug":"um-ensaio-sobre-comentarios","status":"publish","type":"post","link":"https:\/\/www.ufsm.br\/pet\/sistemas-de-informacao\/2020\/04\/14\/um-ensaio-sobre-comentarios","title":{"rendered":"Um Ensaio sobre Coment\u00e1rios"},"content":{"rendered":"\n

Em momentos como o que vivemos agora, \u00e9 de se esperar que a partir do \u00f3cio de ficar em casa surja criatividade. Bom, n\u00e3o foi o meu caso nesses \u00faltimos dias.<\/span><\/p>\n

Para a escrita deste artigo, inicialmente pensei em falar sobre o funcionamento do tempo de execu\u00e7\u00e3o do\u00a0<\/span>JavaScript<\/span>, um tema muito importante para qualquer desenvolvedor\u00a0<\/span>web<\/span>. Entretanto, j\u00e1 existem muitos materiais de qualidade sobre isso, tanto em ingl\u00eas quanto em portugu\u00eas, como a\u00a0<\/span>palestra<\/a><\/span>\u00a0do\u00a0<\/span>Philip Roberts<\/a><\/span>\u00a0na\u00a0<\/span>JSConf EU<\/a><\/span>, em que ele destrincha o funcionamento do\u00a0<\/span>Event Loop<\/span>.<\/span><\/p>\n

Al\u00e9m disso, tamb\u00e9m cheguei a estudar\u00a0<\/span>containers<\/span>\u00a0e suas propriedades, conhecendo experts na \u00e1rea como a\u00a0<\/span>Julia Evans<\/a><\/span>, que oferta materiais incr\u00edveis sobre o tema. De qualquer forma, n\u00e3o foi dessa vez em que escrevi um tutorial sobre eles e tecnologias auxiliares, como\u00a0<\/span>Docker<\/span>\u00a0e\u00a0<\/span>Kubernetes<\/span>.<\/span><\/p>\n

J\u00e1 faz um tempo que tenho vontade de escrever sobre algo n\u00e3o t\u00e3o t\u00e9cnico, mas sim algo que passa despercebido e \u00e9 importante em nosso cotidiano. Foi quando encontrei uma palestra da Sarah Drasner que fez tudo se encaixar para que essa reda\u00e7\u00e3o fosse escrita. Sendo assim, nessa edi\u00e7\u00e3o vamos fugir do formato tradicional do PET Reda\u00e7\u00e3o e discutir um pouco sobre coment\u00e1rios,\u00a0<\/span>gatekeeping<\/span>, vi\u00e9s de sobreviv\u00eancia e outras coisas.<\/span><\/p>\n

Coment\u00e1rios s\u00e3o falhos! Ou ser\u00e1 que n\u00e3o?<\/span><\/strong><\/p>\n

Desde o in\u00edcio da jornada da maioria dos desenvolvedores de software, somos ensinados sobre o qu\u00e3o importante s\u00e3o os coment\u00e1rios em nosso trabalho. At\u00e9 mesmo para os mais incr\u00e9dulos, basta ter que trabalhar em projetos com c\u00f3digo legado ou revisitar projetos antigos para entender a import\u00e2ncia dos coment\u00e1rios. Mas ao contr\u00e1rio do que se aprende no in\u00edcio de nossas carreiras, h\u00e1 um tipo de l\u00f3gica muito presente na cabe\u00e7a de muitos desenvolvedores que j\u00e1 est\u00e3o inseridos no mercado de trabalho: coment\u00e1rios s\u00e3o ruins.<\/span><\/p>\n

Quem nunca ouviu a seguinte frase: \u201cVoc\u00ea n\u00e3o precisa de coment\u00e1rios se escrever um c\u00f3digo limpo\u201d? Muito provavelmente a popularidade dessa ideia se disseminou com o livro\u00a0<\/span>C\u00f3digo Limpo<\/a><\/span>\u00b9<\/span>. Nesse livro, h\u00e1 um cap\u00edtulo dedicado especificamente aos coment\u00e1rios, mas que aborda eles como um mal necess\u00e1rio, iniciando imediatamente com a cita\u00e7\u00e3o abaixo.<\/span><\/p>\n

\u00a0<\/p>\n

\n

\u201c<\/span>N\u00e3o comente c\u00f3digo ruim,\u00a0<\/span>reescreva-o<\/span>\u201d<\/span><\/p>\n

Brian W. Kernighan and P. J. Plaugher<\/span><\/p>\n<\/blockquote>\n

\u00a0<\/p>\n

O autor do livro explica que coment\u00e1rios s\u00e3o essencialmente falhos, porque sua exist\u00eancia j\u00e1 demonstra que o programador falhou em se expressar atrav\u00e9s do c\u00f3digo. Junto disso, tamb\u00e9m ressalta que o c\u00f3digo de uma aplica\u00e7\u00e3o se transforma, \u00e9 apagado, reescrito e assim em diante, e o coment\u00e1rio n\u00e3o o segue nessa evolu\u00e7\u00e3o. Ele afirma que os programadores poderiam ser disciplinados a atualizar os coment\u00e1rios conforme a progress\u00e3o do c\u00f3digo, mas que o melhor a se fazer \u00e9 dispender essa energia totalmente \u00e0 escrita de um c\u00f3digo leg\u00edvel.<\/span><\/p>\n

Todos os pontos levantados por ele podem ser v\u00e1lidos, mas ocorre um equ\u00edvoco em seu racioc\u00ednio. N\u00e3o importa o qu\u00e3o bem escrito e limpo seja o seu c\u00f3digo, h\u00e1 uma limita\u00e7\u00e3o:<\/span><\/p>\n

\u00a0<\/p>\n

\n

\u201c<\/span>C\u00f3digo pode explicar como<\/span>, <\/span>mas n\u00e3o pode explicar<\/span>\u00a0por qu\u00ea<\/span>\u201d<\/span><\/p>\n

Sarah Drasner<\/span><\/p>\n<\/blockquote>\n

\u00a0<\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0Em sua palestra sobre a Arte dos Coment\u00e1rios,\u00a0<\/span>Sarah Drasner<\/a><\/span>\u00b2\u00a0<\/span>demonstra que h\u00e1 uma limita\u00e7\u00e3o lingu\u00edstica de todas as linguagens de programa\u00e7\u00e3o: elas n\u00e3o foram feitas exclusivamente para comunica\u00e7\u00e3o entre seres humanos. Observemos este exemplo: qual dos dois trechos de c\u00f3digos abaixo \u00e9 mais leg\u00edvel?<\/span><\/p>\n

\u00a0<\/p>\n\n\n\n
\n

sum<\/span>\u00a0=\u00a0<\/span>posts<\/span>.<\/span>reduce<\/span>((<\/span>s<\/span>,\u00a0<\/span>p<\/span>)\u00a0<\/span>=><\/span>\u00a0<\/span>s<\/span>\u00a0+=\u00a0<\/span>p<\/span>.<\/span>upvotes<\/span>,\u00a0<\/span>0<\/span>);<\/span><\/code><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

\u00a0<\/p>\n\n\n\n
\n

posts<\/span>.<\/span>forEach<\/span>(<\/span>el<\/span>\u00a0<\/span>=><\/span>\u00a0{<\/span><\/code><\/p>\n

\u00a0<\/span>sum<\/span>\u00a0+=\u00a0<\/span>el<\/span>.<\/span>upVotes<\/span><\/code><\/p>\n

});<\/span><\/code><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

\u00a0<\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0A resposta certa seria: depende. \u00a0N\u00e3o h\u00e1 como afirmar que h\u00e1 um consenso do que \u00e9 um c\u00f3digo leg\u00edvel para todos, j\u00e1 que somos todos pessoas com opini\u00f5es e experi\u00eancias diferentes. Um c\u00f3digo que \u00e9 limpo para n\u00f3s hoje pode se tornar um c\u00f3digo confuso daqui a 5 anos. Sendo assim, n\u00e3o h\u00e1 por que abolir coment\u00e1rios da programa\u00e7\u00e3o assim como n\u00e3o devemos us\u00e1-los como muleta para escrever c\u00f3digos confusos e ruins, mas trat\u00e1-los como uma ferramenta que precisava ser revisada e atualizada assim como qualquer c\u00f3digo.<\/span><\/p>\n

Os coment\u00e1rios podem ser bons!<\/span><\/strong><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span>Podemos destacar v\u00e1rios tipos de coment\u00e1rios que s\u00e3o, sim, importantes e at\u00e9 mesmo necess\u00e1rios em v\u00e1rios momentos, podendo ser tempor\u00e1rios ou at\u00e9 mesmo permanentes. Algumas das situa\u00e7\u00f5es que podemos utilizar os coment\u00e1rios s\u00e3o as seguintes:<\/span>\u00a0 \u00a0 \u00a0<\/span><\/p>\n