Estándares y Procesos Técnicos

INTRODUCCIÓN

Existen diversos beneficios de la codificación estandarizada en la industria del desarrollo de software por los cuales las empresas deciden operar bajo estos estándares. Algunas empresas optan por generar estos documentos con el fin de obtener certificaciones, sin embargo existen otras ventajas como: El mejoramiento de la comunicación en los equipos de desarrollo, Reduce los errores de programación, Mejora la calidad de software, Mejora la productividad de los desarrolladores porque mejora su facilidad de mantenimiento, Mejoran la lectura del software, lo que permite entender código nuevo con mayor rapidez y profundidad.

Sin embargo, es primordial mencionar que para que las convenciones de código generen los beneficios enlistados previamente, es fundamental que todos los miembros del equipo se apeguen a los estándares.

DESARROLLO

1. Ortografía

1.1 Ortografía y tildes Es importante seguir una buena ortografía dentro del código para facilitar la lectura y evitar confusiones. Los tildes se pueden omitir si el equipo decide hacerlo.

1.2 Idioma Se debe establecer en qué idioma se estará desarrollando el código, si las variables tendrán nombres en inglés, etcétera, con el fin de evitar inconsistencias dentro del código.

2. Estructura general

2.1 Comentarios de comienzo Los ficheros fuente deben comenzar con un comentario en el que se lista el nombre de la clase, información de la versión, fecha y copyright.

/* * Nombre de la clase * * Informacion de la version * * Fecha * * Copyright */

2.2 Package e import (Java) La primera línea no comentario de los ficheros fuente Java es la sentencia package y posterior a esta pueden seguir varias sentencias import.

Nota: No se debe encontrar algún import no utilizado dentro del código.

3. Indentación y espaciado

Se deben considerar cuatro espacios como unidad de indentación.

3.1 Longitud de la línea Evitar las líneas de más de 80 caracteres, las líneas de comentarios deben tener una longitud inferior a 70 caracteres.

3.2 Rompiendo líneas Cuando se deba romper una línea porque la expresión no entra dentro los 80 caracteres seguir los siguientes principios: ⁃ Romper después de una coma. ⁃ Romper antes de un operador. ⁃ Alinear la nueva línea con el comienzo de la expresión al mismo nivel de la línea anterior.

3.3 Líneas en blanco

Las líneas en blanco pueden facilitar la lectura al separar secciones de código que están lógicamente relacionadas.

- Usar dos líneas en blanco entre las definiciones de clases e interfaces. - Usar una línea en blanco entre métodos, variables locales de un método y su primera sentencia, antes de un comentario de bloque o de un comentario de línea y entre las distintas secciones lógicas de un método para facilitar la lectura.

3.4 Espacios en blanco

Se deben usar espacios en blanco:

⁃ Una palabra clave del lenguaje seguida por un paréntesis, ejemplo:

while (true) { . . . }

⁃ Después de cada coma en las listas de argumentos. ⁃ Todos los operadores se deben separar por un espacio, los espacios en blanco no deben separar a los operadores unarios. (++, —)

a += c - d; a = (a + b) / (c * d);

while (d++ == s++) { n++; }

⁃ Las expresiones en una sentencia for se deben separa por espacios. ⁃ Al ‘castear’ una variable, el ‘cast’ debe ir seguido por un espacio en blanco.

miMetodo((int) numero, (Object) x);

4. Convenciones y buenas prácticas

4.1 Evitar código repetido El mismo pedazo de código no debería de repetirse en otra parte del código.

4.2 Evitar el anidamiento profundo (‘Deep nesting’) Demasiados niveles de anidamiento pueden hacer que el código sea difícil de leer y de seguir.

4.3 Establecer una estructura para archivos y folders Mantener una estructura correcta de folders puede hacer que el código sea más mantenible.

4.4 Convenciones de nombres Se deben seguir convenciones de nombres para clases, variables, métodos, etc (Ejemplo: siempre usar nombres en plural para listas, arreglos, etc.)

4.5 Mantener el código lo más simple que se pueda Un código complejo puede ser difícil de mantener y entender.

REFERENCIAS

Hommel, S. (2001). Convenciones de Código para el lenguaje de programación JAVA. 2 agosto 2019, de UM.es Sitio web: https://www.um.es/docencia/vjimenez/ficheros/practicas/ConvencionesCodigoJava.pdf

Domínguez, E. (2015). REGLAS DE CALIDAD PARA LA CODIFICACIÓN ESTANDARIZADA EN LENGUAJE C: UNA PROPUESTA PARA LA ENSEÑANZA A NIVEL SUPERIOR . 2 agosto 2019, de UANL Sitio web: http://eprints.uanl.mx/9199/1/Reglas.pdf