Hay una diferencia entre escribir código y escribir código bueno. Es esencial asegurarse de que su código sea legible y comprensible para usted, su equipo e incluso para un forastero que lo vea. Aquí hay algunas prácticas de programación a considerar:
Usar Comentarios
Los comentarios pueden sonar triviales y puede resultar aburrido escribirlos, pero son útiles. Los comentarios son especialmente útiles en proyectos grupales. Le ayudará a usted y a otros a recordar lo que hace una sección de código. También aumentará la legibilidad general. En lugar de usar comentarios para comentar secciones de código, intente usarlos para decir qué hace el código en su lugar.
Usa El Editor Correcto
Bloc de notas es odiado por las razones correctas. Si va a escribir código, también puede hacerlo en un software adecuado. El editor correcto proporcionará mejores opciones de legibilidad y depuración. Considere opciones como VS Code , Vim , Atom , Notepad ++ y Sublime . Si desea más, consulte nuestra lista de los 5 principales editores gratuitos de código fuente para programadores .
Cometer Cambios, Siempre
Nunca se sabe lo que podría pasar. Su sistema podría fallar y usted podría perder todo su trabajo. Considere usar Github para obtener su código de almacenamiento en línea. Y siempre trata de cometer tus cambios. Una vez que haya realizado una tarea y tenga algo que funcione sin fallas, confíelo. Aquí hay una lista de los comandos importantes de Git que todo programador debe conocer .
Variables Descriptivas
Nombrar y declarar variables puede sonar como una tarea fácil, pero en realidad no lo es. Podría pasar minutos tratando de averiguar el nombre de variable perfecto para usar. Evite los nombres como var1, var2, etc. y, en cambio, obtenga más variables descriptivas. El uso de variables descriptivas es algo así como "autodocumentación".
Uno puede ir a través del código y entender de inmediato para qué sirve cada variable. Comprensiblemente, hay momentos en que la descripción de las variables puede volverse larga y tediosa. Siempre trate de hacerlo lo más corto y lo más descriptivo posible.
Documentación
Documentar su trabajo es la tarea temida. pero tienes que hacerlo. O deberías hacerlo. La autodocumentación a veces es adecuada, donde puede explicar todo lo que su código usa comentarios en el código y las variables descriptivas. La documentación no es todo sobre esto. A veces, tiene que abrir un archivo diferente para explicar los requisitos del sistema, el diseño, etc.
¿Funciona? No Lo Toques
Una vez que su código se compile sin errores, no intente tocarlo y experimentar con él. O si va a hacer esto, al menos, guarde primero una copia del código sin errores. Puedes pensar que estás tratando de mejorar las cosas, pero podrías estar haciendo exactamente lo contrario. No vayas creando bugs cuando no hay ninguno. Y en caso de que lo estropee, recuerde que siempre puede usar " Ctrl + z ".
Conclusión
Esta lista es solo la punta del iceberg. Existen otras prácticas que los programadores senior considerarán ideales. Y se dirá que los consejos anteriores son innecesarios por algunas personas. Todos tienen derecho a sus propias opiniones. Nadie está obligado a seguir reglas como comentar, variables descriptivas y lo que no. Pero una vez que empiezas a seguirlos, empiezas a ver cuánto más fácil puede ser la codificación.
0 Comentarios