Estándar de codificación Java

Vista previa del material en texto

Resúmenes 
Principios de construcción de software 
Ramón Gómez Romero 
P6 
Definiendo el estándar de codificación 
S20015736 
Daniela Morales Sixto 
10 de marzo de 2023 
 
Actividad 6 
 
Facultad de Estadística e Informática 
 
 
Principios de construcción de software 
 
Contenido 
1. Introducción ................................................................................................................................ 4 
2. Propósito ..................................................................................................................................... 4 
3. Nombrado .................................................................................................................................... 5 
3.1. Variables .............................................................................................................................. 5 
3.2. Constantes ........................................................................................................................... 6 
3.3. Métodos ............................................................................................................................... 6 
3.4. Clases .................................................................................................................................. 7 
4. Estilo de código ........................................................................................................................... 7 
4.1. Indentación .......................................................................................................................... 7 
4.2. Corchetes ............................................................................................................................. 7 
4.3. Espacios en blanco .............................................................................................................. 8 
4.3.1. Espacio en blanco vertical ............................................................................................... 8 
4.3.2. Espacio en blanco horizontal ........................................................................................... 9 
4.4. Paréntesis ............................................................................................................................. 9 
4.5. Estructuras de control .......................................................................................................... 9 
4.5.1. If else .......................................................................................................................... 9 
4.5.2. For ............................................................................................................................. 10 
4.5.3. While ......................................................................................................................... 10 
4.5.4. Do while .................................................................................................................... 10 
4.5.5. Switch ........................................................................................................................ 11 
4.5.6. Try catch .................................................................................................................... 11 
5. Comentarios .............................................................................................................................. 12 
5.1. Comentarios de bloque ...................................................................................................... 13 
5.2. Comentarios de una sola línea ........................................................................................... 14 
6. Organización de archivos .......................................................................................................... 14 
6.1. Sufijos de archivos ............................................................................................................ 14 
6.2. Archivos de código java .................................................................................................... 14 
6.3. Orden de archivos de código ............................................................................................. 14 
7. Declaración de variables ........................................................................................................... 15 
7.1. Visibilidad de atributos de clase ........................................................................................ 15 
7.2. Declaración de variables de método .................................................................................. 15 
7.3. Variables de retorno ........................................................................................................... 15 
 
Facultad de Estadística e Informática 
 
 
Principios de construcción de software 
 
8. Idioma ....................................................................................................................................... 16 
 
 
Facultad de Estadística e Informática 
 
 
Principios de construcción de software 
 
1. Introducción 
En el siguiente documento se especifica el estándar a utilizar para el desarrollo del proyecto 
de Principios de construcción de software. El lenguaje para utilizar será Java, y se 
establecerán reglas acerca del nombrado de variables, el formato, el uso de caracteres 
especiales, nombrado de clases, etc. La versión de este estándar es la 1.0. 
 
2. Propósito 
El propósito de este estándar es tener una guía durante el proyecto. El estándar permitirá 
tener un código más legible, seguro, del mismo modo brindará mayor velocidad al 
desarrollo del proyecto. Facilitará la integración de los miembros del equipo en la 
construcción del producto y evitará discusiones sobre la identidad del código.
 
Facultad de Estadística e Informática 
 
 
Principios de construcción de software 
 
 
3. Nombrado 
En esta sección se explicará lo relacionado con el nombrado y estilo que tomaran los distintos 
elementos y entidades que conformaran el código como lo son las variables, métodos y clases. 
 
3.1. Variables 
Para la identificación de las variables se deben seguir las siguientes reglas: 
1. Se hará uso de la notación camelCase. 
2. El nombrado deberá de ser un sustantivo que revele la intención de dicha variable y en su 
caso deberá especificar que se mide y como se mide. 
3. Para nombrar a las variables no se podrá hacer uso de números ni caracteres especiales en 
ningún momento. 
 
Incorrecto Correcto 
 
 
 
 
 
 
 
 
 
 
 
 
Facultad de Estadística e Informática 
 
 
Principios de construcción de software 
 
3.2. Constantes 
Para la identificación de las constantes se deben seguir las siguientes reglas: 
1. Deberán de cumplir con el estilo UPPER_SNAKE_CASE: todas las letras en 
mayúscula, con cada palabra separada de la siguiente por un único guión bajo. 
 
 
3.3. Métodos 
Para la identificación de métodos se deberá cumplir con lo siguiente: 
1. Los nombres de los métodos se escribirán con el estilo lowerCamelCase. 
2. Los métodos deben ser verbos. 
3. En cuanto al cuerpo del método estos deberán de ser pequeños, en caso de que un método 
sea largo se deberá de dividir o refactorizar. 
 
Incorrecto Correcto 
 
 
 
 
Incorrecto Correcto 
 
 
Facultad de Estadística e Informática 
 
 
Principios de construcción de software 
 
3.4. Clases 
1. Los nombres de las clases deben ser sustantivos. 
2. Los nombres de las clases deben comenzar con una letra mayúscula. En la mayoría de los 
casos, una sola palabra basta como nombre de la clase. 
3. En caso de que el nombre esté compuesto por más de una palabra, se seguirá el estilo 
impuesto como UpperCamelCase. 
 
Incorrecto Correcto 
 
 
 
4. Estilo de código 
 
4.1. Indentación 
1. Deberá aplicarse a toda estructura que esté lógicamente contenida dentro de otra. El 
sangrado será de un tabulador. 
 
 4.2. Corchetes1. Los corchetes deberán seguir el estilo K & R a excepción de que debe colocarse un espacio 
después del elemento que lo necesite. 
• Ningún salto de línea antes de la llave de apertura. 
• Salto de línea antes de la llave de cierre. 
• Salto de línea después de la llave de cierre, solo si esa llave termina una declaración o 
termina el cuerpo de un método, constructor o clase con nombre. 
2. El uso de corchetes es obligatorio para toda estructura de control. 
 
 
 
 
Facultad de Estadística e Informática 
 
 
Principios de construcción de software 
 
Incorrecto Correcto 
 
 
 
 
4.3. Espacios en blanco 
1. Antes y después de un operador a excepción del operador punto(.) 
2. Los parámetros de las funciones deben estar separados por un espacio después de cada 
coma. 
 
Incorrecto Correcto 
 
 
 
4.3.1. Espacio en blanco vertical 
Siempre aparece una sola línea en blanco: 
1. Entre miembros consecutivos o inicializadores de una clase: campos, constructores, 
métodos, clases anidadas, inicializadores estáticos e inicializadores de instancia. 
2. Una sola línea en blanco también puede aparecer en cualquier lugar donde mejore la 
legibilidad, por ejemplo, entre para organizar el código en subsecciones lógicas. Una 
línea en blanco antes del primer miembro o inicializador, o después del último miembro 
o inicializador de la clase, no se recomienda ni desanimado. 
 
 
Facultad de Estadística e Informática 
 
 
Principios de construcción de software 
 
4.3.2. Espacio en blanco horizontal 
Más allá de donde lo requiera el lenguaje u otras reglas de estilo, y aparte de literales, comentarios y 
Javadoc, un solo espacio ASCII también aparece solo en los siguientes lugares. 
1. Separar cualquier palabra reservada 
2. En ambos lados de cualquier operador binario o ternario. 
3. Después o el paréntesis de cierre () 
4. Entre cualquier contenido y una doble barra diagonal () que comienza un comentario. 
Se permiten múltiples espacios.// 
5. Entre el tipo y la variable de una declaración: List<String> list 
6. Opcional justo dentro de ambas llaves de un inicializador de matriz 
7. Antes y después de un operador a excepción del operador punto(.) 
8. Los parámetros de las funciones deben estar separados por un espacio después de cada 
coma 
 
4.4. Paréntesis 
Utilizar paréntesis generosamente en expresiones que incluyan operadores mixtos para evitar 
problemas de precedencia de operadores. 
Incorrecto Correcto 
 
 
 
4.5. Estructuras de control 
4.5.1. If else 
La llave de apertura deberá ubicarse al final de la condicional if y las llaves de cierre en una línea 
después del cuerpo de la estructura. La instrucción else, deberá ir entre el la llave de cierre del 
último if y su llave de apertura. 
Incorrecto Correcto 
 
 
 
Facultad de Estadística e Informática 
 
 
Principios de construcción de software 
 
 
4.5.2. For 
Las llaves de apertura deberán ubicarse al final de la expresión del ciclo for y la llave de cierre en 
una línea después del cuerpo del ciclo. 
Incorrecto Correcto 
 
 
 
 
 
4.5.3. While 
Las llaves de apertura deberán ubicarse al final de la expresión del ciclo while y la llave de cierre en 
una línea después del cuerpo del ciclo. 
Incorrecto Correcto 
 
 
 
 
4.5.4. Do while 
Las llaves de apertura deberán ubicarse al final de la expresión del ciclo do while y la llave de cierre 
en una línea después del cuerpo del ciclo. 
Incorrecto Correcto 
 
 
 
 
Facultad de Estadística e Informática 
 
 
Principios de construcción de software 
 
 
4.5.5. Switch 
Las llaves de apertura deberán ubicarse al final de la expresión de la estructura switch y la llave de 
cierre en una línea después del cuerpo de la estructura. Cada case, break y default deberá alojarse en 
una línea por separado, además se deberá dejar una línea vacía entre cada case, break y default. 
Incorrecto Correcto 
 
 
 
 
4.5.6. Try catch 
Las llaves de apertura deberán ubicarse al final de la expresión del bloque try catch y la llave de 
cierre en una línea después del cuerpo de la estructura. Del mismo modo que else, en el caso de if, 
las instrucciones catch y finally se encontrarán entre las llaves de cierre y su respectiva llave de 
apertura 
 
Incorrecto Correcto 
 
 
 
 
Facultad de Estadística e Informática 
 
 
Principios de construcción de software 
 
 
5. Comentarios 
 
Se recomienda abstenerse a hacer comentarios en el código a excepción de los siguientes casos: 
1. Comentarios legales 
 
 
 
2. Comentarios informativos1 
 
 
 
 
 
3. Intento de explicación 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1 No se recomiendan, ya que para eso se pueden utilizar los nombres representativos 
 
Facultad de Estadística e Informática 
 
 
Principios de construcción de software 
 
4. Advertencia de consecuencias 
 
 
 
 
 
 
 
 
 
 
En general para los comentarios se deben cumplir con las siguientes reglas: 
1. Deben explicar el por qué no el como. 
2. Evitar comentarios que expliquen el uso de variables, métodos, pruebas, etc. 
3. Evita utilizar “ASCII Art” 
 
5.1. Comentarios de bloque 
Un cometario de bloque debe ir precedido por una línea en blanco que lo separe del resto del 
código. 
 
 
 
 
 
 
 
 
 
 
Facultad de Estadística e Informática 
 
 
Principios de construcción de software 
 
5.2. Comentarios de una sola línea 
Debe de colocarse antes un sangrado de un tabulador a partir de donde se va a empezar a escribir y 
en caso de que no se pueda escribir en una sola línea debe seguir la regla de comentario por bloque. 
 
 
 
 
6. Organización de archivos 
En este capítulo se explicarán todas las convenciones a seguir para la construcción y estructuración 
del código a través de los archivos que conformarán el sistema de software. 
 
6.1. Sufijos de archivos 
 
Tipo de archivo Sufijo 
Archivos de código java .java 
Archivos de código de bytes java .class 
 
 
 
6.2. Archivos de código java 
Las clases en Java que comparten un grupo de funcionalidades relacionadas deben estar 
empaquetadas en un nuevo paquete dentro del proyecto. 
 
6.3. Orden de archivos de código 
Los archivos de código java deben tener el siguiente orden: 
• Sentencias package e import 
• Comentarios de inicio 
• Declaración de la clase o interfaz 
 
 
 
Facultad de Estadística e Informática 
 
 
Principios de construcción de software 
 
7. Declaración de variables 
En esta sección se denotan todas las características y detalles a tener en cuenta a la hora de declarar 
y crear variables en el código del proyecto. 
En general se deben de cumplir las siguientes reglas: 
1. Las variables se deben de declarar todas juntas al inicio de la clase. 
 
7.1. Visibilidad de atributos de clase 
Los atributos de clase serán declarados todos juntos al inicio de la clase. Los atributos de clase serán 
declarados de acuerdo con su visibilidad en el siguiente orden: privados, protegidos y públicos. 
 
7.2. Declaración de variables de método 
Todas las variables necesarias dentro de un método de clase serán declaradas al inicio de dicho 
método, inclusive si no son valoradas o necesarias en ese momento. 
Cada variable debe de cumplir con solo una función a excepción de variables cuyo uso sea 
únicamente auxiliar (contadores de ciclo, almacenes temporales de datos). 
 
7.3. Variables de retorno 
Los métodos que necesiten realizar algún retorno de valor deben evitar el uso excesivo de return, en 
caso de que sea necesario retornar alguna variable se deberá de utilizar un solo return. 
Incorrecto Correcto 
 
 
 
 
 
 
Facultad de Estadística e Informática 
 
 
Principios de construcción de software 
 
8. Idioma 
Utilizaremos el idioma español como predeterminado en todo el desarrollo del Código.