Buenas prácticas al programar.


Publicado por el 2/04/2018. Categoría: Sugerido

Toda actividad tiene ciertas pautas que mejoran nuestro desempeño, la programación no es la excepción. Contar con buenas prácticas no sólo nos facilita el trabajo, sino que también mejoran nuestro trabajo.

Nunca abandones el papel y lápiz.

Muchos suelen creer que papel y lápiz ya es cosa del pasado, craso error. Si bien en la computadora podemos tener acceso a distintas herramientas, el papel y lápiz seguirán siendo grandes compañeros de trabajo. Ayudan a plasmar las ideas rápidamente. Ya que el diseño podemos hacerlo rápidamente. Esto nos permite hacer una distribución rápida y precisa de cómo queremos que se materialice nuestro proyecto. Sirve para anotar ideas nuevas, problemas que necesitamos corregir y hasta soluciones para los problemas que aún no surgen.  Además, ¿quién no disfruta de un buen trazo en el papel mientras desarrolla un proyecto?

Comenta el código.

Muchas veces nos olvidamos de documentar, pero la documentación del código es uno de los pasos más importantes. Esto te permite tener una idea clara de lo que hace cada segmento del código, lo cual te puede ayudar a corregir errores y reciclar código. Comentar el código permite a otros profesionales del ramo, poder comprender el código fácilmente; al entregar un proyecto debes dejar la opción de que alguien más se encargue de la auditoría, la documentación facilitará dicha tarea y es un requisito indispensable al entregar un proyecto. También te puede ayudar mucho, si el proyecto es un trabajo especial de grado, porque así podrás tener ventajas en la defensa al contar con material de soporte.

Cargando...

Versiona.

Siempre debes contar con versiones de tu proyecto, ya que estas versiones te permiten regresar a un estado donde el sistema funciona como debería y con una actualización se pierde funcionalidad. Guardar proyecto sobre sí mismo no es la mejor idea, sobre todo si cambias grandes bloques de código. Incluso una línea puede significar un gran problema.

Indentación (Tabular).

Recuerda ordenar tu código de forma jerárquica. Cada bloque de código debe obedecer a una tabulación, a fin de que el código sea más legible.

Sigue los estándares básicos.

Convención de nombres: Aunque la siguiente lista se utiliza principalmente en JAVA, suele aplicarse en muchos lenguajes.

Tipo de identificador Reglas para nombrar Ejemplos
Clases Los nombres de clase deben ser sustantivos en Upper CamelCase, con la primera letra de cada palabra en mayúscula. Use palabras completas – evitar acrónimos y abreviaturas (a menos que la abreviatura es mucho más extendida que el de la forma larga, como la dirección URL o HTML). class Raster;

class ImageSprite;

Métodos Los métodos deben ser verbos en lower CamelCase o un conjunto de varias palabras que comienza con un verbo en minúsculas; es decir, con la primera letra en minúscula y la primera letra de las palabras siguientes en mayúsculas. run();

runFast();

getBackground();

Variables Las variables locales, variables de instancia y variables de clase también se escriben en lower CamelCase. Los nombres de variable no deben comenzar con los caracteres guion bajo (_) o el signo de dólar ($), aunque ambos se admiten. Esto contrasta con otras convenciones de codificación que establecen que los guiones deben ser usados como prefijo todas las variables de instancia. Los nombres de variables deben ser cortos pero significativos. La elección de un nombre de variable debe ser diseñada para indicar al observador casual la intención de su uso. Se deben evitar los nombres de variables de un solo carácter excepto para las variables temporales “usar y tirar”. Los nombres comunes de las variables temporales son i, j, k, m, y n para enteros; c, d, y e para los caracteres. int i;

char c;

float myWidth;

Constantes Los nombres de las constantes se deben escribir en mayúsculas separadas por guiones bajos. Los nombres de constantes pueden contener dígitos, pero no como el primer carácter. final static int MAX_PARTICIPANTS = 10;

Fuente

Optimiza el código.

A medida que vayas leyendo tu código, sabrás que podrás optimizar para tener un código más eficiente. Nunca olvides guardar tus versiones anteriores antes de realizar optimizaciones. Esto también incluye inicializar las variables, evitar funciones y procedimientos repetidos. Si trabajas con programación orientada a objetos, aprovecha los módulos.

Organiza tu distracción.

Siempre debes tener tiempo para distraerte, una constante carga de estrés no será nada bueno. Hazte un jardín o un huerto, incluso un jardín Zen (No hablamos de Zen-Coding); algo que te distraiga. No solo ayuda a relajarte, sino también a que surjan nuevas ideas.

buenas prácticas

Mantente saludable.

Puede sonar raro, pero un buen estado de salud ayuda mucho al fluir de las ideas. Muchísimas veces me acostaba de madrugada con un problema de código que no podía resolver. Mientras intentaba conciliar el sueño, la solución surgía y me levantaba a resolver el problema. A esas horas realizaba las pruebas y luego volvía a dormir unas pocas horas. Es lo que más desgasta, no dormir  o comer adecuadamente. Un cuerpo sano te da una buena reserva de energía para los días en que no logras dormir. Pero nunca exageremos, siempre hay que tener tiempo para reposar adecuadamente y conservar un buen estado de salud.

¡Suscribete ya y recibe información al día!

Manuel Enrique Portabarria

Amante de la informática como profesión, ecologista y escritor por pasión.

Deja un comentario

Cargando...

Esta web utiliza cookies para obtener datos de la navegación de sus usuarios. Si continúas navegando asumiremos que aceptas su uso.

OK | Más información