¿Qué buenos hábitos sigues para escribir un buen código?

Mi especialidad universitaria es ingeniería de software. Como desarrollador, desarrollar buenos hábitos de codificación al comienzo del aprendizaje puede ahorrar mucho tiempo y costos, haciendo que el código escrito sea más fácil de entender y expandir, y más versátil.

Entonces, ¿qué buenos hábitos he seguido?

Leer más buen código.

Cuando tengas tiempo, echa un vistazo a algunos excelentes códigos de framework de código abierto. No es necesario estudiarlos a fondo, siempre y cuando puedas aprender algunos conceptos de diseño excelentes. Puede ver el código fuente depurando en los puntos de interrupción.

Leer más documentos oficiales, que deben ser la información más precisa y en tiempo real. La persona que redacta el documento oficial suele ser el desarrollador de la tecnología o el software. Ellos son los que mejor saben estas cosas, por lo que los documentos que escriben no sólo son de alta calidad, sino también lo último en contenido.

Nombres estandarizados

ITWorld lanzó una vez una encuesta sobre "Los problemas más problemáticos de los programadores". Como resultado, casi la mitad de los programadores consideran que los nombres son su mayor dolor de cabeza. Algunas personas se dan por vencidas al escribir código y usan nombres que solo ellos pueden entender. Algunas personas no lo entienden a primera vista.

Denominación de funciones, variables, nombres de clases, etc. Debería tener su propio significado. Ya sea una variable interna o una variable global, debe crear sus propias reglas de nomenclatura para poder comprender el significado de las variables de un vistazo. Una buena denominación puede mejorar enormemente la legibilidad y el mantenimiento del código.

Comenta con cuidado

Al igual que nombrar, hay dos cosas que dan dolor de cabeza a los programadores: escribir comentarios y no escribir comentarios cuando otros los leen. El propósito de escribir un comentario es hacerle saber lo que escribió la próxima vez que lo vea. Es posible que ni siquiera sepas lo que escribiste cuando vuelvas a mirar tu código, y mucho menos cómo se sentirán los demás después de leer tu código.

Escribe notas cuando sea necesario para que la persona que se hace cargo pueda entender el código y ponértelo más fácil, pero las notas deben ser precisas y no numerosas.

Programación modular

Modularizar el código y extraer la lógica común puede aclarar la estructura del código y facilitar la localización de errores cuando ocurren.

El anidamiento de código es algo que hacemos a menudo. Si bien el anidamiento en sí no tiene nada de malo, a veces puede hacer que el código sea más difícil de leer.

Para evitar anidamientos innecesarios, podemos utilizar el patrón de diseño de "retorno anticipado", que nos permite utilizar sentencias if como cláusulas de protección para comprobar si hay errores y regresar antes de ejecutar el siguiente código.

Los buenos hábitos de programación realmente deben desarrollarse desde el principio. Incluso si no es código fuente abierto, debemos tomarlo en serio y desarrollar buenos hábitos de programación a través de la práctica continua.