notifications Notificaciones

Marcar todas como leídas

Ver más

¿Que es una guía de código?

Carlos Eduardo Cantoral Penagos.

Twitter black efdb1623688b2a14a7705d191dbbe0265332efb257756a714f7fb5403f5e782c @

¿Que son las Guías de Código?

Las guías de código (también llamadas estándares de código o estilos de programación) es el nombre que se le da al conjunto de normas usadas para escribir código fuente, estas son regularmente dependientes del lenguaje de programación que se haya elegido. Un buen estilo para programar debe tener una estructura de código fácil de entender no solo para sí mismo sino también para otra gente y aportar eficiencia al proceso de desarrollo, logrando que los programas sean más robustos y comprensibles.

Durante la etapa de codificación el buen uso de las guías de código puede evitar problemas en:

  1. La calidad del programa:
    Al momento de depurar errores en un programa mal escrito el desarrollador debe invertir mucho tiempo en descubrir que es lo que está pasando y darle solución. Un buen estilo facilita la lectura y corrección rápida de los errores.

  2. Mantenimiento de Software:
    La mayor parte del tiempo durante la tarea de mantenimiento se emplea para leer y comprender el código existente, dado que el código que parecía obvio al momento de elaborarse tiende a ser confuso y poco entendible tiempo después cuando se vuelve a revisar, este hecho se hace más notable cuando el código fue elaborado por otra persona. El buen uso de las practicas asegura que los programas sean más comprensibles y por ende más fáciles de mantener.

  3. Comunicación entre el equipo de desarrollo:
    Para los miembros dentro de un equipo de desarrollo es necesario que utilicen un estilo común en el código que generen, manteniendo así la homogeneidad del código y garantizando la comunicación entre los miembros del equipo.

Cada programador tiene su propio estilo por ello he aquí criterios que te ayudaran a mejorar a la hora de escribir código:

Nombres de Variables y Procedimientos

Los nombres de variables y procedimientos definidos deben tener significado. Estos nombres deben ser auto explicativos y representativos con respecto a su propósito. La información nombrada sin sentido solo logra dificultar la lectura y compresión del código.

Indentación

Básicamente la indentación es usada para tener una mejor visibilidad en el diseño de un programa, nos muestra las líneas que son subordinadas de otras líneas. La mayoría de los lenguajes utilizan llaves para indentar o delimitar bloques de código.

Espaciado

La mayoría de los lenguajes ignoran los espacios en blanco, sin embargo, mejora la legibilidad y comprensión, agrega espacios en los siguientes lugares:

  • Los parámetros de las funciones deben estar separados por un espacio después de cada coma
  • Entre operadores
  • Luego de punto y coma en bucles for
  • Antes y después del operador de asignación

Comentarios del Código

Las secciones de código deben tener comentarios donde se defina su función de forma clara de tal forma que pueda ser documentada y entendida posteriormente, además de proveer información adicional que no es legible en el código mismo.

Funciones Coherentes

Cada función debe ser diseñada para una tarea simple, si el procedimiento maneja muchas tareas es más difícil de entender y propenso a que suceda un error.

Llaves

Utiliza siempre las llaves, incluso para los bloques que contienen sólo una sentencia. Esto elimina una fuente común de bugs y facilita el mantenimiento

Longitudes y saltos de línea

Escribe una sentencia por línea solamente, trata de evitar que la línea no sobrepase los 80 caracteres como máximo, si es necesario aplica un salto de línea de manera notoria:

  • Luego del operador de asignación.
  • En expresiones aritméticas y lógicas antes de un operador.
  • En las invocaciones de método luego del paréntesis de apertura.

Paréntesis

Utiliza los paréntesis en expresiones que impliquen distintos operadores para evitar problemas con la precedencia, pues, aunque creas que la precedencia es clara, puede que esto no sea así para otros.

¿Donde encontrarlas?

Como se menciono anteriormente cada guía de código depende del lenguaje de programación a utilizar y en Internet existen distintas fuentes en donde las puedes encontrar, pero nosotros te recomendamos las guías que son creadas por la comunidad, ya que estas crecen y se mejoran día tras día gracias a los aportes de las personas que contribuyen con el proyecto.

A continuación algunas guías que te pueden interesar:

1 respuesta
favorite 1

Inicia sesión o Regístrate para poder agregar tu respuesta.