¡¡¡Sea imperativo!!!  TL;DR: Las funciones con nombres poco claros ocultan la intención y confunden a los lectores. Utilice nombres descriptivos y orientados a la acción.  Problemas  Propósito de la función poco claro  Aumento de la carga cognitiva  Contexto engañoso  Legibilidad reducida  Colaboración difícil  Funcionalidad oculta  Soluciones  Utilice verbos orientados a la acción  Haz que   sean descriptivos los nombres  Reflejar el propósito de la función  Evite términos genéricos  Proporcionar un contexto significativo  Expresar claramente la responsabilidad única  Hacer coincidir la acción con el resultado  Refactorizaciones   https://hackernoon.com/improving-the-code-one-line-at-a-time  Contexto  Las funciones nombradas con términos genéricos obligan a los lectores a sumergirse en la implementación para comprender su comportamiento.  Esto desperdicia tiempo y aumenta las posibilidades de errores.    se vuelve aún más crítica cuando se trabaja con funciones independientes, donde el nombre de la clase no proporciona contexto adicional. La denominación  Esta cuestión está directamente relacionada con el   . principio de “cuéntalo, no preguntes”  En lugar de exponer comportamientos ambiguos que obligan al llamador a inferir la funcionalidad, los nombres imperativos transmiten la acción exacta, guiando al lector sin necesidad de inspeccionar el código.  Al nombrar funciones de manera descriptiva, eliminas conjeturas innecesarias y te alineas con este principio.  Código de muestra  Equivocado   public String dateFormatting(Date date) { return new SimpleDateFormat("yyyy-MM-dd").format(date); } public void load() { System.out.println("Loading..."); }  Bien   public String formatDate(Date date) { return new SimpleDateFormat("yyyy-MM-dd").format(date); } public void loadUserPreferences() { System.out.println("Loading user preferences..."); }  Detección    Manual [x]  Puedes detectar este olor revisando los nombres de funciones que utilizan términos vagos como   ,   ,   ,   , etc. do run process load  Los linters automatizados pueden marcar estos patrones o resaltar funciones con nombres demasiado genéricos.  Etiquetas  Nombramiento  Nivel    Principiante [x]  ¿Por qué es importante la biyección?  Los nombres de las funciones deben crear una   entre su nombre y su funcionalidad. correspondencia clara uno a uno  Romper esta   obliga a los desarrolladores a examinar los detalles del código para buscar contexto, lo que ralentiza la depuración, las revisiones y las extensiones. biyección  Generación de IA  Las herramientas de IA a veces generan nombres de funciones genéricos sin comprender su dominio.  Al utilizar IA, especifique que los nombres de las funciones deben ser descriptivos y orientados a la acción.  Detección de IA  Los modelos de IA pueden ayudar a detectar nombres ambiguos comparando las firmas de funciones con las mejores prácticas de nombres predefinidas.  La combinación de IA con la revisión manual del código produce los mejores resultados.  ¡Pruébalos!   Recuerde: los asistentes de IA cometen muchos errores  Sin instrucciones adecuadas  Con instrucciones específicas   ChatGPT   ChatGPT   Claudio   Claudio   Perplejidad   Perplejidad   Copiloto   Copiloto   Géminis   Géminis  Conclusión  Los nombres de funciones no son sólo etiquetas; son contratos con el lector.    rompen este contrato y generan confusión. Los nombres ambiguos  Los nombres descriptivos y orientados a la acción simplifican la comunicación y hacen que su código sea más fácil de mantener y ampliar.  Relaciones   https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-vii-8dk31x0?embedable=true https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xxxi?embedable=true   https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-viii-8mn3352?embedable=true https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xxxv?embedable=true  Véase también   https://hackernoon.com/what-exactly-is-a-name-the-quest-part-i-fmw3udc?embedable=true   https://hackernoon.com/what-exactly-is-a-name-rehab-part-ii-4st3uph?embedable=true  Descargo de responsabilidad  Los olores del código son mi   . opinión  Créditos  Foto de   en  britishlibrary Unsplash  El nombre de una función debe ser un verbo o una frase verbal y debe tener significado.   Robert C. Martín   https://hackernoon.com/400-think-provoking-software-engineering-quotes?embedable=true  Este artículo es parte de la serie CodeSmell.   https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-i-xqz3evd?embedable=true

This story contains new, firsthand information uncovered by the writer.

Winner of Noonies 2020 for the award Hacker Noon Contributor of the Year - REFACTORING.

Code Smell 285: Cómo solucionar problemas con funciones no imperativas

About Author

COMENTARIOS

ETIQUETAS

ESTE ARTÍCULO FUE PRESENTADO EN

Related Stories

Nómadas digitales escuchen: lo que necesitan saber sobre la nueva visa DTV de Tailandia

De los foros a los feeds: cómo los algoritmos de las redes sociales influyen en la interacción digital

¿Quieres ganar un concurso de redacción de HackerNoon? Esto es lo que recomiendan los ganadores del concurso #crypto-api

Una guía del arquitecto para crear una arquitectura de referencia para un lago de datos de IA/ML

Nómadas digitales escuchen: lo que necesitan saber sobre la nueva visa DTV de Tailandia

De los foros a los feeds: cómo los algoritmos de las redes sociales influyen en la interacción digital

¿Quieres ganar un concurso de redacción de HackerNoon? Esto es lo que recomiendan los ganadores del concurso #crypto-api

Una guía del arquitecto para crear una arquitectura de referencia para un lago de datos de IA/ML

Light-Mode

Classic

Newspaper

Minty

Dark-Mode

Neon Noir

Minty

HN StartUps