Está PROHIBIDO Comentar el Código

Descubre el debate sobre si debes comentar tu código, hablaremos sobre su importancia, sus riesgos y algunas recomendaciones como los Test

[maurocenturion]

TypeScript tiene en TODO su código comentarios. No porque sea un "mal código", sino por una cuestión de guiar mejor al programador para usarlo.

[AlfonzoDiez]

Esto me hace recordar cuando trabaje en una consultora y los programadores incluían en el código las quejas a la empresa, hablándole y disculpándose con el programador del futuro, era muy gracioso cuando me encontraba uno al tocar o corregir algo.

[kmilosd]

Como recomendación, comiencen a dejar comentarios útiles en el código e incluso en la base de datos. Las herramientas IA los utilizan y se vuelven muy potentes.

[Zyx]

- El código sin comentar es mal código.
- El código que necesita comentarios es mal código.

[javisartdesign]

Totalmente deacuerdo con los puntos. Los test (sobre todo los unitarios, ya que el resto son úlitles pero al final intentan resolver otros problemas ) deberían de poder contar la historia de qué hace el código (clase, función, etc..), es decir para documentar la funcionalidad de que hace y que no hace. Los comentarios son útiles si están para un propósito específico y teniendo en cuenta que el código no deja de ser un lenguaje y debería poder leerse y entenderse. En los casos en los que no se entienda porque se esté trabajando a bajo nivel o sea poco expresivo entonces si que toman sentidos los comentarios.

[Kesp-sm]

Decía mi profesor de la universidad que si programas bien no necesitas comentarios porque se entendía y que eras mal programador si ponías. Nadie de mi facultad entendía su código y no por la dificultad 😢

[megapixeler]

En un trabajo horrible (aunque en una empresa de renombre) me hacían la vida imposible con cualquier tema, hasta el punto en que llegamos a los comentarios... Me exigían que todo quedara sin comentarios... Ya llegados a ese punto era todo tan absurdamente forzado que desde entonces tengo una animadversión severa contra la gente aboslutista; Ahora que estoy a cargo de proyectos me aseguro de evitar políticas así de retrasadas.

[JCodeDeveloper]

Me llamó mucho la atención cuando mencionas, "colocar un comentario y no sea verdad que sea mentira 3:50 . No se si a ustedes les pasa pero en mi persona cuando escribo código, yo me frustro por que las cosas queden bien hechas y en el fondo eso me llena el alma. ¿Quien colocaría un comentario falso? ¿Bajo que propósito? La verdad no logro asimilar eso jajaja

[Moralo]

Es una estupidez como un piano; Los lenguajes de programación tienden a mutar bastante con el tiempo, aparte de poseer innumerables librerías con un comportamiento muy heterogéneo, llenas de clases, funciones etc. Esto hace que no comentar el funcionamiento del código sea un dolor de cabeza de cara a un mantenimiento posterior, cuando dichas librearías ya no se usen, se hayan olvidado o hayan cambiado.
Para un programador es IMPOSIBLE saber que hace cada condenada función de cada librería de cada lenguaje de programación; sencillamente no hay memoria humana posible.
Cualquier persona dedicada a la ingeniería o al mundo de la «técnica», como ingenieros civiles, arquitectos, fontaneros o electricistas, suelen dejar una memoria de los proyectos, una documentación, para que así los operarios o trabajadores del futuro sepan qué se ha hecho y cómo.
Y en la industria del software y la tecnología es peor, porque requiere de unas infraestructura enormes y complejas que cambian bastante con el tiempo. Un plano de una casa, de una instalación eléctrica o sanitaria no suelen cambiar casi nada a lo largo de los años, pero en el mundo del software y la tecnología aparecen nuevos lenguajes y herramientas en cuestión de meses, y muchas otras se olvidan o se dejan de utilizar.
La escritura de documentación y comentarios hace que el mantenimiento de cara a futuro sea mucho más fácil y ágil, y se ahorre así una extensa peregrinación por librerías y webs antiguas y farragosas, aparte de facilitar el trabajo a aprendices, juniors o gente que no esté familiarizada con dicho lenguaje o tecnología.

[jasom]

Aquí el problema es que la peña se lee ciertos libros como Clean Code y se creen que eso va a misa

[lechuck]

En realidad, comentario depende del caso. Estoy de acuerdo con el tio bob en que un comentario demuestra la incapacidad de expresarse en codigo(sea por limitacion del lenguaje o la habilidad, tiempo, etc del programador) Por eso hay que reducir la cantidad de comentario(sobre todo porque no deja de ser una linea de codigo a mantener que puede quedar obsoleta). Si estoy de acuerdo en documentar usando xDoc los metodos(sobre todo publico). Pero comentar para no tratar de escribir un codigo mejor, me parece que es lo que esta mal.

[SoyArthu]

Ya que salió este tema de sí comentar o no el código. . . Les contaré una breve historia: Hasta el año pasado que termine la universidad (solo me enseñaron lo básico de lo básico), una de las mejores practicas (Para algunos tal ves sea lógico) es que tus variables, así seas de habla hispana, inglesa, japonesa, etc. Siempre deben tener sentido.
Por ejemplo: public function comprobarRutas( ) {. . .
En mis compañeros vi que hacían esto: public function cmurl( ) { . . .
o en java usan t, l=2 ; y pasaba el tiempo y les preguntabas ya no sabían que era, porque a parte no comentaban el código, lo que si no es bueno, o al menos para, es que el dejes los comentarios en producción.
Bueno solo quería contar mi experiencia. Saludos a todos.

[mubris]

Hay comentarios que son una salvación y hay comentarios que sólo estorban y ensucian.

Queda a juicio del programador cuándo es útil y cuando no.

En general la mejor práctica es hacer el código lo más autoexplicativo posible y si ya no puedes hacer nada más por mejorar su claridad sin perder en otras cosas, entonces sí recurrir a ellos.

[OscarKlee]

Me gustó el comentario de comentar “porque se hizo así” más que lo que hace el código.

Yo si pongo comentarios es más para generar después la documentación de allí (como JavaDoc)

[unapersona]

Muy de acuerdo. Increíble que haya gente que no comente el código. Dicen de forma autista que el buen código no necesita explicaciones... Pero quién hace buen código?

[mateupego]

Yo empecé a trabajar en una empresa como programador y lo pasé muy mal al no tener ningún comentario pero siempre lo respete y bueno las empresas tienen sus razones para hacer las cosas a su manera….

[Jerbo_]

El Ego de los programadores llega a ser molesta cuando de parecer superior se trata.

[GC-mqgj]

El problema es, si eres principiante y no pones comentarios dentro de unos meses no te acordarás de lo que has hecho. Yo ahora mismo y "para mí" quizás ponga muchos comentarios pero creo que eso favorece el aprendizaje. También lo que he hecho a veces es hacer un archivo con comentarios para mí y otro sin ellos para enviar los ejercicios aún así el profesor no me ha dicho nada cuando los he puesto. Yo creo que lo peor es ver un código ilegible...

[Offline_Channel]

Así me funen yo pongo comentarios solo en funciones complicadas que expliquen que hace el código pero en las simples que cualquier mortal lo entiende no se pone nada 😅

[leonardohidalgo]

Son útiles y no es tan difícil la práctica de un buen comentario, pasa que muchos no siguen las convenciones y por eso llenan de comentarios innecesarios sus códigos, y en respuestas otros programadores terminan odiando a los comentarios en general por contaminar visualmente la lectura del código cuando el culpable real fue un programador que no sabe hacer comentarios.
Un comentario debe estar para explicar un ¿por qué?, no deben estar para colocar los ¿qué es? o ¿que hace?. El "Que" lo responde el mismo código si se realiza de forma limpia y descriptiva, los mismo nombres de variables, funciones, métodos y hasta parte del controlflow responden todos los "que" del propio código. Eso solo te deja una porción muy reducida que puede y es útil comentarse y es para explicar los porque.