Published on Marco de Desarrollo de la Junta de Andalucía ([Link]
junta-
[Link]/servicios/madeja)
Convenio de codificación específico para PL/SQL
Área: Especificaciones de Codificación y Construcción
Tipo de pauta: Directriz
Carácter de la pauta: Obligatoria
Tecno lo gías: PL/SQL
Có digo : LIBP-0009
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ítulo Carácter
Formato del código Obligatoria
Caracteres no permitidos Obligatoria
Alineación Obligatoria
Bloque anónimo Obligatoria
Condiciones Obligatoria
Bucles Obligatoria
Sentencia SELECT Obligatoria
Sentencias INSERT / DELETE / UPDATE Obligatoria
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.
Volver al índice
Caracteres no permitidos
No utilizar caracteres no permitidos
No se usará ni la letra 'ñ' ni vocales con tilde, salvo en comentarios.
Volver al índice
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.
Volver al índice
Bloque anónimo
Seguir siempre la misma estructura de código en los bloques anónimos
1
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.
Volver al índice
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.
Volver al índice
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.
Volver al índice
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.
Volver al índice
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
Volver al índice
Pautas
Área: Desarrollo » Especificaciones de Codificación y Construcción
Có digo Título Tipo Carácter
LIBP-0008 Convenio de codificación general Directriz Obligatoria
Recursos
Área: Desarrollo » Especificaciones de Codificación y Construcción
Có digo Título Tipo Carácter
Implementación de convenios de codificación en
RECU-0733 Ejemplo Recomendado
PL/SQL
RECU-0107 Manual de desarrollo en PL/SQL Manual Recomendado
Source URL: [Link]