Definición de nombres

Inicio

Los nombres deben ser descriptivos. Se intenta que el nombre sea autodescriptivo.

// mal
Proc: CliCre
PortalGetAgendasCliente
getEmpresaIdxCliente

// bien
Proc: ClienteCrear

Utilizar PascalCase al nombrar objetos, atributos y variables. más info

// mal
clientecrear
Clientecrear
getSufijo

// bien
ClienteCrear

No utilizar underscore al inicio o final en ningún tipo de objeto, atributo o variable.

Esto puede hacer suponer a un programador proveniente de otros lenguajes que tiene algún significado de privacidad.

// mal
&_CliNom = "John Doe"
&CliNom_ = "John Doe"
Proc: _ClienteCrear

// bien
&CliNom = "John Doe"

Dominios

Nombrar los dominios enumerados sin abreviar, comenzando con la entidad en singular y siguiendo con el calificador enumerado también en singular. Los valores enumerados también se deben especificar en singular.

Esto es para facilitar la definición de atributos y variables basadas en un dominio (GeneXus lo hará automáticamente).

// mal
DocumentosTipo
DocumentosTipos
DocTipos
domColorEstados
Mensajes

// bien
DocumentoTipo { Venta, Compra, etc}
DocumentoModo { Credito, Débito}
ColorEstado
Mensaje

Procedimientos

Nombrar procedimientos relacionados mediante Entidad + Atributo(depende el caso) + Complemento + Acción.

Esto permite agrupar los objetos de la misma entidad en la selección de objetos entre otros.

Algunas acciones típicas son Get, Set, Load (para SDT), Insert, Utpdate, Delete,Is etc.

La diferencia entre Set y Update es que Set refiere a un atributo y Update a una entidad.

Usamos la Acción Is para comprobar que la entidad cumple con alguna condición, ejemplo para comprobar que un usuario sea administrador UsuarioAdministradorIs

// mal
CreCli
UpsertCliente
FechaCliente
getSufijo
isUserAdministrator

// bien
ClienteUpsert
ClienteEliminar
ClienteFechaModificadoGet
ClienteFechaModificadoSet
DocumentoRecalculo
EmpresaNombreSufijoGet
UsuarioAdministradorIs

Atributos

Utilizar nomenclatura GIK para nombrar atributos.

Se pueden crear atributos sin el límite de los 3 caracteres si el nombre no supera los 20 caracteres y mejora la comprensión. Estandar desde los inicios de GeneXus.

// mal
CreCliFch
FechaCreadoCliente

// bien
CliFchCre

// mejor
ClienteFechaCreado

Transacciones

Las transacciones deben tener el nombre de la entidad en singular. Se define así porque en la comunidad GeneXus está claro que queda mejor a la hora de trabaja por ejemplo con Business Component. También es requerimiento de algunos patterns GeneXus para su correcta visualización (ej.: K2BTools).

// mal
Trn:Articulos
Trn:Clientes

// bien
Trn:Cliente
Trn:Articulo