Escribir código legible y simple

Hoy estaba revisando mi cuenta de twitter y ví un mensaje de Emily Jiang que es Arquitecto del Proyecto Open Liberty de IBM.

Emily Jiang

@emilyfhjiang

Te sigue

Java Champion, MicroProfile guru, IBMer, runner, mum to Emma and Adam, passionate about Java +Jakarta EE, conference speaker. Tweets are my own.

Fui a revisar su blog y el articulo "Write Readable and Simple Code" mencionado es realmente genial y que todos deberíamos leer.  Como se que muchos no leemos ingles, decidí tomarle la atribución de traducirlo al Español. Espero Emily (@emilyfhjiang) no se moleste.

Traducción a continuación:

"Soy una gran admiradora del código simple y legible. Cada línea de código debe ser lo más autoexplicativa posible. Cada línea de código debería ser estrictamente necesaria. Para lograr un código legible y simple, hay dos aspectos a considerar: formato y contenido. Aquí les dejo algunos consejos para ayudarles a escribir código que sea simple y legible:

1. Use identación para diseñar tu código de forma clara. Úsala constantemente. Si trabajas en un proyecto, debe haber una plantilla de código. Todos en el equipo deben adoptar el mismo formato de código. No mezcles espacios con tabs. Siempre ten el IDE configurado para mostrar espacios en blanco y tabs para que se pueda detectar la mezcla y corregirlos. (Personalmente, me encantan los espacios). Elija espacios o tabs, y manténgase firme.
2. Usa nombres de variables y nombres de métodos significativos. El código es mucho más fácil de mantener si se explica por sí mismo. Con identificadores significativos, su código puede hablar solo en lugar de necesitar una línea de comentarios separada para explicar lo que hace. Manténgase alejado de los nombres de variables de una letra. Si los nombres de sus variables y métodos tienen un significado claro, normalmente no necesitará comentarios para explicar lo que hace su código.
3. Comenta tu código si es necesario. Si la lógica es muy compleja, como consultas de expresiones regulares, etc., usa la documentación para explicar lo que el código está tratando de hacer. Una vez que haya comentarios, debes asegurarte de que se mantengan. Los comentarios no mantenidos causan confusión. Si necesita advertir a un mantenedor sobre algo, asegúrese de documentarlo y destacarlo, como agregar "ADVERTENCIA" al comienzo de un comentario. A veces, un error puede detectarse y repararse más fácilmente si el autor original expresa su intención o pone una advertencia en alguna parte.
4. No verifique el código comentado. Eliminelo para mejorar la legibilidad. Uno de los argumentos comunes sobre el código comentado es que algún día el código comentado podría ser necesario. La verdad es que podría permanecer allí durante años, sin mantenimiento y causando confusión. Incluso si algún día desea descomentarlo, el bloque de código podría no compilarse ni funcionar como se esperaba, ya que la base podría haber cambiado significativamente. No lo dudes. Solo bórralo.
5. No sobre-ingenie agregando algún código que pueda ser útil en el futuro. Si tiene la tarea de ofrecer alguna funcionalidad, no se exceda al incluir lógica especulativa adicional. Cualquier código adicional corre el riesgo de introducir errores y gastos generales de mantenimiento.
6. Evite escribir código detallado. Apunte a escribir menos líneas de código para lograr una tarea. Más líneas introducen más errores. Realice un prototipo primero mediante una lluvia de ideas para realizar la tarea y luego pula el código. Asegúrese de que cada línea tenga una buena razón para existir. Si es gerente o arquitecto, no juzgue a sus desarrolladores por la cantidad de líneas de código que entregan, sino por lo limpio y legible que es su código.
7. Aprenda programación funcional, si no es parte de sus skills. Una de las ventajas de usar las características introducidas en Java 8, como lambdas y streams, es que estas características pueden ayudar a mejorar la legibilidad de su código.
8. Adopte programación en pareja. La programación en pareja es una excelente manera para que un desarrollador junior aprenda de alguien que tiene más experiencia. También es una excelente manera de escribir código significativo, ya que necesita explicar sus elecciones y razonamientos a la otra persona. Un gran proceso lo alienta a escribir código con cuidado en lugar de descargar el código.

El código tendrá menos errores si es simple y legible: es probable que el código complejo tenga más errores; es probable que el código que no se entiende fácilmente tenga más errores. Con suerte, estos consejos pueden ayudarlo a mejorar sus habilidades y su código, ¡para entregar un código que sea simple y legible!"

Llegamos al final. Tremendo post. 

Como buen Peruano, tuve la suerte de conocerla en el Oracle Code One 2019 y le pedí un selfie, ademas de mencionarles que ojalá algún día visite el Perú. Encantados de recibirla en @Perujug.

Emily continúa con el buen trabajo. Sigue inspirando a las chicas a optar por esta hermosa carrera de IT. 

Continue with the great job!!! Keep inspiring to more girls to enter the world of IT.

Cheers

Joe