Utilizar prefijos específicos de proyecto en nombres de artefacto

Debe añadir como prefijo a todos los nuevos nombres de artefacto de origen (clases de modelo, archivos de origen, mensajes, archivos de mensajes, etc.) una palabra abreviada o acrónimo relevante. Utilice siempre el mismo acrónimo o palabra abreviada. A medida que el proyecto avance, esto hará que las adiciones del proyecto a artefactos principales resulten más evidentes. Esta distinción pasa a ser muy útil a medida que aumenta el esfuerzo de desarrollo. Normalmente, la mayoría de proyectos se describirán mediante alguna clase de acrónimo. Este acrónimo es un buen candidato para utilizar como prefijo.

La utilización de un prefijo específico del proyecto evita que se produzcan conflictos de nombres entre artefactos nuevos que añada y artefactos nuevos que Cúram añada con el tiempo; los conflictos de nombres pueden resultar costosos y difíciles de corregir cuando se producen.

Por ejemplo, considere adoptar un Service Pack y descubrir que una de las adiciones de campos de base de datos personalizadas tiene el mismo nombre que un nuevo campo de la aplicación que no tiene el mismo tipo de datos o significado empresarial. Como alternativa, considere adoptar un Service Pack y descubrir que se ha añadido una nueva aplicación Elemento de tabla de códigos que está en conflicto con un elemento personalizado que también ha añadido con el mismo nombre, pero con distinto significado. Estos tipos de conflictos se pueden evitar si se asegura de que siempre se añade un prefijo coherente a los nuevos nombres de artefactos personalizados.

Algunos tipos de artefactos tienen más de un identificador y estos se deben tener en cuenta al darles nombre. Por ejemplo, las clases de entidad y los elementos de tabla de códigos. Un clase de entidad personalizada tiene un nombre de tabla que comparte el mismo espacio de nombres sin formato (el esquema de base de datos) como tablas de aplicaciones y debe tener un nombre de tabla exclusivo en ese espacio de nombres. También tiene un nombre de clase Java, que comparte un espacio de nombres jerárquico (estructura de paquetes) con clases Java de la aplicación. De la misma forma, un elemento de tabla de códigos personalizado tiene tanto un valor como un identificador Java, y ambos comparten un espacio de nombres sin formato con elementos de aplicación en la misma tabla de códigos.

Es importante tener en cuenta que la utilización de prefijos específicos de proyecto no es aplicable cuando está sustituyendo un artefacto de aplicación, ya que el mecanismo de sustitución normalmente se basa en nombrar el artefacto personalizado exactamente con el mismo nombre que el artefacto de aplicación que sustituye.

Consideraciones adicionales:

• Los identificadores se proporcionan de muchas formas, por ejemplo, un nombre de archivo, un ID XML, un nombre de clase Java o una combinación de estos.
• Se aconseja un prefijo corto ya que hay muchos lugares con restricciones de longitud (por ejemplo, determinados tipos de identificadores de base de datos).