Hemos decidido iniciar una serie de artículos de patrones y prácticas con la herramienta de desarrollo Velneo v7. El motivo fundamental es fijar todos los criterios de desarrollo adecuados para el crecimiento futuro de PaaSOS.

Empecemos con algo de poco peso (técnicamente hablando) pero demasiado trascendental para dejarlo en el tintero, las reglas de nombrado:

Lo primero es como nombrar cada una de las cosas que utilizamos en PaaSOS sobre todo aquello que sea trascendental para el crecimiento futuro.

Nombrado;

Reglas básicas:

  • Todo lo nombrado será coherente (si nombramos todo de una misma forma será bastante manejable a largo plazo).
  • Estará nombrado en ingles para facilitar el crecimiento de la plataforma.

Reglas de nombrado para tablas:

  • Las tablas del núcleo de PaaSOS llevarán como nombre el que identifique el tipo de información guardada en la misma. Si queremos una tabla para guardar notas simplemente la llamaremos NOTES.
  • Respecto a las tablas de módulos anexos llevaran como nombre una terna acompañada del nombre de la misma. Por poner un ejemplo si queremos crear una tabla de entidades para nuestro módulo ERP la llamaremos ERP_ENTITIES.

Reglas de nombrado de objetos fundamentales: Para los objetos más utilizados en PaaSOS se utilizará una terna que identifique el tipo de objeto.

Ejemplos:

  • Acción (Action): ACT_
  • Cesta de la compra (Basket): BSK_
  • Esquema de tablas (Scheme): SCH_
  • Librería externa (External library): LIB_
  • Fichero adjunto (Attachment): ATT_
  • Procesos (Process): PRC_
  • Funciones (Function): FNC_
  • Colas (Queue): QUE_
  • Formularios (Form): FRM_
  • Multivistas (Multiview): MLV_
  • Rejillas (Grids): GRD_
  • Informes (Reports): RPT_
  • Búsqueda (Query): SQL_
  • Árbol visor de tablas (Table tree viewer): TRE_
  • Lupa (Filter glass): FLT_
  • Localizador (Finder): FND_
  • Bloc de formularios (Form bloc): BLC_
  • Tubo de lista (List pipe): LPP_
  • Tubo de ficha (record pipe): RPP_
  • Casillero (Slot): SLT_
  • Toolbar (Toolbar): TLB_
  • Dispositivo serie (Serial): COM_
  • Protocolo TCP/IP (TCP/IP Protocol): TCP_
  • Menús (Menu): MNU_

Reglas de nombrado de objetos secundarios: Los objetos secundarios creados en PaaSOS utilizarán una descripción clara del objeto al que representan (sin terna que describa el tipo).

Ejemplos:

  • Constante (Constant): ERROR, FRM_DELETE_TITLE, BTN_CANCEL, MSG_NOT_OWNER
  • Dibujo (Picture): ALARM_CLOCK, FLAG_GREEN, FLAG_PURPLE, SYS_CURRENT_SESSION_ID
  • Variable (Variable): SYS_SYSTEM_USER_NAME
  • Marco (Frame): AUTOEXEC
  • Control Svg (SVG Control): BUTTON_BERYL
  • Imagen Svg (SVG Image): BUTTON_BERYL_NORMAL, BUTTON_BERYL_PRESSED

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *