Lineamientos | Nombramiento de Metodos
Los métodos deben generarse con la siguiente nomenclatura de nombrado para asegurar la claridad, consistencia y mantenibilidad del código:
Métodos Públicos:
Estilo: Los nombres de los métodos públicos deben seguir la convención CamelCase, comenzando siempre con una letra minúscula.
Semántica: El nombre debe ser un verbo o una frase verbal que describa de forma precisa la acción o la operación que realiza el método. Evitar abreviaturas ambiguas o acrónimos poco comunes que puedan dificultar la comprensión.
Ejemplos:
getUserByIdcreateNewOrderupdateProductStockcalculateTotalPriceauthenticateUsersendEmailNotificationprocessPaymentvalidateInputData
Métodos Privados (o Protegidos):
Estilo: Similar a los métodos públicos, los nombres de los métodos privados (o protegidos, según el lenguaje) deben utilizar la convención CamelCase comenzando con una letra minúscula.
Distinción: Para diferenciar los métodos privados de los públicos, se recomienda utilizar un prefijo de guion bajo (_) al inicio del nombre del método. Esta convención debe aplicarse de manera consistente en toda la base de código.
Propósito: El nombre del método privado debe reflejar la lógica interna específica o el paso particular dentro de la funcionalidad de un método público al que sirve de soporte.
Ejemplos:
_verifyUserPermissions_formatOrderData_updateDatabaseRecord_logActivity_sendHttpRequest
Número Recomendado de Parámetros:
Se recomienda encarecidamente mantener el número de parámetros de un método lo más reducido posible, Un número reducido de parámetros mejora la legibilidad de la firma del método y facilita su comprensión.
Ideal: El número ideal de parámetros para un método es de cero (0) a tres (3).
Alternativas para Reducir el Número de Parámetros:
Cuando un método requiera conceptualmente más de tres parámetros, se deben considerar las siguientes alternativas:
Agrupar Parámetros en Objetos (DT/Value Objects): Crear objetos específicos para encapsular un conjunto de parámetros relacionados lógicamente. Pasar una única instancia de este objeto al método mejora la claridad y reduce el número de argumentos.
Utilizar el Patrón Builder: Para objetos con múltiples atributos, especialmente si algunos son opcionales, implementar el patrón Builder permite construir el objeto de manera fluida y pasar una única instancia al método.
Dividir la Funcionalidad del Método: Si un método con muchos parámetros realiza múltiples tareas, se debe considerar refactorizarlo en métodos más pequeños y especializados, cada uno con una responsabilidad clara y un número reducido de parámetros.
Excepciones:
Si bien se recomienda limitar el número de parámetros, pueden existir casos justificados donde un método requiera más de tres. Sin embargo, antes de implementar un método con una gran cantidad de parámetros, se debe realizar una revisión exhaustiva para asegurar que no existan alternativas de diseño más claras y mantenibles.