logo linux

Así se comenta el código según Torvalds

Linus Torvalds vuelve a echar unca bronca. Esta vez está relacionado con los comentarios del código fuente de la api de cifrado del kernel.

Con su habitual tono de bronca cuando pilla un cabreo, Torvalds ha explicado cómo comentar el código fuente. El mensaje que ha dejado dice lo siguiente:

¿Nos podemos deshacer de esa sintaxis estúpida de descerebrados que se usa en redes para comentar, POR FAVOR?

Si la gente de redes no se puede manejar con el estilo puramente genial, equilibrado y simétrico de comentarios tradicional de C, entonces en vez de usar la mierda desequilibrada que usáis ahora, por favor usad la forma del C++.

En otras palabras, estos tres modelos son buenos:

(a)
/* Esto es un comentario *./

(b)
/*
* Esto también es un comentario, pero puede separarse
* limpiamente en varias lineas
*/

(c)
// Esto puede ser una sola linea. O varias. Tu eliges.

y todos ellos están visualmente equilibrados. A veces quieres (b) incluso para una sola linea, pero puedes hacerlo con (c) también con tan solo rodearlo con dos lineas de comentario vacías.

La forma (c) es particularmente buena para cosas como comentarios enum o estructuras al final del código, donde podrías querer alinear las cosas, pero el marcador de final de comentario acaba distrayendo la mirada.

Hay otro estilo tradicional y aceptable para varias lineas que encontrarás en algunas partes, pero no es el estilo común del kernel:

(d)
/* Este es un formato multi-linea alternativo
que no es horrible, pero no es el estilo de kernel */

Fíjate cómo todos los estilos de comentarios de arriba tienen cierta simetría visual y equilibrio.

Pero no, el código de red no ha cogido *ninguno* de los formatos sensatos de arriba. En vez de eso, se han cogido estos dos modelos que son una mierda pinchada en un palo:

(no)
/* Esta es una mierda asquerosa
* que debería morir
*/

(no-no-no)
/* Este también es repugnante
* y visualmente desequilibrado */

Por favor. El código de red en realidad tiene el *peor* estilo de comentarios posible. Puedes encontrar el estilo (no-no-no) que es increíblemente repugnante y peor que el, por otra parte, mucho más familiar estilo (d).

Ni siquiera voy a empezar a hablar sobre la gente que prefiere meter en cajas sus comentarios y alinear ambos finales y tener cajas molonas de estrellas rodeando todo el tema. Estoy seguro de que tiene un buen aspecto si estás de LSD hasta las cejas y no tienes nada mejor que hacer que preocuparte por la correcta alineación de los asteriscos.

Me gustaría empezar a mudar todo el kernel al estilo de C++; han pasado muchos muchos años desde que teníamos problemas de compatibilidad y ahora estamos todos acostumbrado incluso si no éramos fans al principio.

De verdad que no entiendo por qué la gente de redes piensa que su estilo particularmente feo está bien. Son las versiones más desequilibradas visualmente de todos los estilos comunes de comentarios y no tiene ventajas reales.

Así que simplemente deshaceos de las formas (no-no) y (no-no-no). No de golpe pero conforme la gente toque el código, que se vaya arreglando ese estropicio.

Linus.

El mensaje original se puede leer en las listas de correo del kernel.

1 comentario en “Así se comenta el código según Torvalds

Los comentarios están cerrados.