Funciones - Denominación

Las funciones pertenecientes a un código fuente deben denominarse de acuerdo con su aplicabilidad y su alcance de actuación.

Los posibles alcances de actuación son:

1. Funciones principales y auxiliares de una rutina, informe o consulta.

La actuación exclusiva y limitada a la rutina, informe o consulta, siempre se declara con alcance estático cuando se trata de una función auxiliar y con alcance público cuando la función es la entrada principal.

1. Funciones genéricas de utilización por el módulo (Facturación, Compras, Contabilidad).

Actuación exclusiva para el entorno del módulo, presente en un código fuente del tipo biblioteca y con alcance público.

1. Funciones genéricas de utilización por el equipo del producto (Materiales, Ventas y CRM, Framework, RR.HH).

Actuación exclusiva para un determinado equipo, presente en un código fuente del tipo biblioteca y con alcance público.

En la creación y desarrollo de una función, es imprescindible que el analista que diseñó y el analista de desarrollo, analicen con cuidado la responsabilidad y las funciones que tendrá la función. En muchas situaciones una determinada función que está diseñada para formar parte de una determinada rutina puede generalizarse para su utilización en el módulo, o en el equipo del producto, o incluso, hasta en el framework. Evite la creación de funciones genéricas dentro de códigos fuente biblioteca, siempre que sea posible consulte el framework para que esta función o clase pueda transferirse al equipo correcto, mejorando su desempeño.

Para la función principal de una rutina, informe o consulta, utilice el nombre del archivo.

Ejemplo: Función de inclusión de datos presente FINA050: FINA050().

Para funciones auxiliares de una rutina, informe o consulta, utilice el estándar:

XYNNNXXXXX()
X - Primera letra del nombre del código fuente.
Y - Tipo de operación indicado en el código fuente.
NNN - Identificador del código fuente.
XXXXX - Abreviación descriptiva del objetivo de la función.

Ejemplo: Función de inclusión de datos presente FINA050: FA050Inclu().

Para funciones genéricas de utilización por el módulo, utilice el estándar:

XXZZZZZZZZ()
XX - Prefijo del módulo de la línea Microsiga Protheus. Por ejemplo: GP para el módulo de Gestión de personal, PO para el módulo de Reloj registrador electrónicos, FT para el módulo de Facturación, etc.
ZZZZZZZZ - Abreviación descriptiva del objetivo de la función.

Ejemplo: Función genérica del módulo Facturación: FTFuncaoGenerica().

Para funciones genéricas de utilización por el equipo del producto, utilice el estándar:

XXZZZZZZZZ()
XX - Abreviación en el nombre del equipo, ejemplo: VC para Ventas y CRM, MT para Materiales, etc.
ZZZZZZZZ - Abreviación descriptiva del objetivo de la función.

Ejemplo: Función genérica del equipo de Recursos Humanos: RHFuncaoGenerica().