Convenio de codificación específico para PL/SQL

LIBP-0009 (Libro de pautas)

Se recogen una serie de convenios de codificación específicos de PL/SQL, a tener en cuenta además de los generales

Las convenciones a la hora de codificar ayudan a la uniformidad y legibilidad del código fuente, facilitando su mantenimiento por terceros y eliminando la dependencia del desarrollador.

Pautas

TítuloCarácter
Formato del código Obligatoria
Caracteres no permitidosObligatoria
AlineaciónObligatoria
Bloque anónimoObligatoria
Condiciones Obligatoria
BuclesObligatoria
Sentencia SELECTObligatoria
Sentencias INSERT / DELETE / UPDATEObligatoria

Formato del código

El código generado deben tener el formato correcto

El código PL/SQL generado debe estar correctamente formateado siguiendo normas de indentación, alineación, bloques, etc. ya sea mediante el uso de una herramienta automática de formateo o de forma manual.

Caracteres no permitidos

No utilizar caracteres no permitidos

No se usará ni la letra 'ñ' ni vocales con tilde, salvo en comentarios.

Alineación

La sangría será de 3 espacios en blanco

El sangrado será de 3 caracteres, debiendo emplearse espacios en blanco y nunca el carácter de tabulación.

Bloque anónimo

Seguir siempre la misma estructura de código en los bloques anónimos

Las palabras clave BEGIN, EXCEPTION y END se encontrarán alineadas, estando tabuladas las líneas internas a cada bloque. Dentro del bloque de excepciones, la sentencia WHEN aparecerá desplazada a la derecha respecto a EXCEPTION y las sentencias incluidas se desplazarán a la derecha respecto a la palabra WHEN.

Condiciones

Utilizar siempre la misma estructura de código en las condiciones

Las palabras claves IF, ELSE, ELSEIF, END IF se encontrarán alineadas en la misma columna para la misma sentencia, teniendo un desplazamiento a la derecha en las líneas internas. La palabra reservada THEN se pondrá a continuación de la condición.

Bucles

Emplear siempre la misma estructura para el código de los bucles

Las palabras claves LOOP y END LOOP se encontrarán alineadas en la misma columna para la misma sentencia, teniendo un desplazamiento a la derecha en las líneas internas.

Las palabras claves WHILE / FOR y END LOOP se encontrarán en la misma columna para la misma sentencia, teniendo un desplazamiento a la derecha en las líneas internas. La palabra clave se pondrá a continuación de la condición.

Sentencia SELECT

Seguir siempre la misma estructura de código en las sentencias SELECT

Las distintas cláusulas (INTO, FROM, WHERE, ORDER BY, START WITH, CONNECT, HAVING, GROUP BY, etc.) y los operadores lógicos irán siempre al comienzo de una nueva línea.

Sentencias INSERT / DELETE / UPDATE

Utilizar siempre la misma estructura de código en las sentencias

Las distintas cláusulas comenzarán en una nueva línea (WHERE, SET, VALUES), de forma análoga a la sentencia SELECT