dificultad en las funciones de nomenclatura

Question

Duplicar posibles:
Anyone else find naming classes and methods one of the most difficult part in programming?

A veces parece que no puedo realmente encontrar ningún nombre para una función que estoy escribiendo, puede ser porque la función no es coherente ¿suficiente?

¿Qué hace cuando no le viene a la mente un buen nombre para una función?

Answer 1

Por nombrar funciones, simplemente evitar tener simplemente sustantivos y que más bien los verbos nombre después. Algunos punteros:

1. Tienen nombres de funciones que son únicos visiblemente, p. Ej. no tiene validateInput() y validateUserInput() ya que es difícil decir lo que uno hace sobre otro. Además, evite tener caracteres que se vean muy similares, p.el número 1 y la letra minúscula 'l'. A veces hace una diferencia.
2. ¿Estás trabajando en un proyecto con varias personas? También debe dedicar un tiempo a revisar las convenciones de nombres, como si el nombre de la función debe tener guiones bajos, debe ser camelCase, etc.
3. La notación húngara es una mala idea; evitar hacerlo
4. Piensa en lo que hace la función. La cohesión que mencionaste en tu pregunta me viene a la mente. En general, las funciones deberían hacer una sola cosa, por lo que no debe llamarse constructCarAndRunCar(), sino tener una función que construya y otra que la ejecute. Si tus funciones están entre, digamos 20 y 40 líneas, estás bien.
5. A veces, y esto depende del proyecto, es posible que también prefiera el prefijo de sus nombres de función con la clase si la clase es puramente de procedimiento (solo compuesta de funciones). Entonces, si tienes una clase que se encarga de ejecutar una simulación, nombra tus funciones sim_pauseSimulation() y sim_restartSimulation(). Si su clase está basada en OOP, esto no es un problema.
6. No utilice las estructuras de datos subyacentes en las funciones mismas; estos deben ser abstraídos. En lugar de tener funciones como addToVector() o addToArray(), haga que sean addToList(). Esto es especialmente cierto si se trata de prototipos o las estructuras de datos pueden cambiar más adelante.
7. Finalmente, sea coherente en sus convenciones de nomenclatura. Una vez que inventas una convención después de pensar, mantente firme. PHP viene a la mente cuando se piensa en nombres de funciones inconsistentes.

Happy coding! :)

Answer 2

Dale tu mejor opción y vuelve a factorizar más tarde si aún no cabe.

Answer 3

Vaya a www.thesaurus.com y trate de encontrar un nombre mejor con sinónimos.

Answer 4

A veces podría ser que su función sea demasiado grande y, por lo tanto, haga demasiadas cosas. Intente dividir su función en otras funciones y podría ser más claro qué llamar a cada función individual.

No se preocupe por nombrar cosas con una o dos palabras. A veces, si las funciones hacen algo que pueda explicarse en una especie de minipreferencia, adelante y asigne un nombre a la función un poco más si esto ayuda a otros desarrolladores a comprender lo que está sucediendo.

Otra sugerencia es obtener comentarios de los demás. A menudo, otros que vienen desde otra perspectiva y ven la función por primera vez tendrán una mejor idea de cómo llamar a la función.

Answer 5

Casi tan importante como el nombre de la función es que usted es coherente con los comentarios. Muchos IDE utilizarán los comentarios formateados correctamente, no solo para proporcionar ayuda contextual para una función que pueda estar usando, sino que pueden usarse para generar documentación. Esto es invaluable al regresar a un proyecto después de un largo período o cuando se trabaja con otros desarrolladores.

En entornos académicos, proporcionan una apreciada demostración de sus intenciones.

Una buena regla de oro es [verb] returnDescription. Esto es fácil con las funciones de tipo GetName() y no se puede aplicar universalmente. Es difícil encontrar un equilibrio entre el código discreto y el descriptivo.

Aquí hay un .Net convention guide, pero es aplicable a la mayoría de los idiomas.

Answer 6

Me resulta más fácil nombrar las funciones cuando no tengo que recortar las palabras. Mientras no hagas javascript para la página de inicio de google, puedes hacer nombres más largos.

Por ejemplo, usted tiene el método dequeueReusableCellWithIdentifier y mergeChangesFromContextDidSaveNotification en manzanas cacao.

Mientras está claro cuál es la función que está haciendo puede que el nombre lo que quiera y refactorearlo más tarde.

Answer 7

Sigo la regla siguiente: Nombre según propósito (¿Por qué? - decisión de diseño) y no a los contenidos (¿Qué, cómo? - se puede ver en el código).

Para las funciones, casi siempre es una acción (verbo) seguido del nombre de los parámetros y (o resultados (Fuera del tema pero para las variables no usa "arrayOfNames" o "listOfNames", estas son tipo de información pero simplemente "nombres"). Esto también se evitan inconsistencias si refactorizar el código en parte.

Para patrones dados como la creación de objetos, sean consistentes y utilizan siempre la misma denominación como "Crear ..." (y no a veces "Asignar ..." o "Construir ..." de lo contrario, usted o sus colegas terminarán rascándose la cabeza)

Answer 8

Como regla práctica propia, si el nombre de una función es demasiado largo, debe ser atomizado en un nuevo objeto. Sin embargo, estoy de acuerdo con todas las publicaciones anteriores. por cierto, buena pregunta de novato