Nombres de variable largos

Question

Digamos que tengo una variable que contiene la cantidad de nombres de motores de búsqueda en un archivo, ¿cuál le gustaría nombrar?

• number_of_seach_engine_names
• search_engine_name_count
• num_search_engines
• motores
• engine_names
• otro nombre?

El primer nombre describe con precisión qué contiene la variable, pero ¿no es demasiado largo ?, ¿algún consejo para elegir los nombres de las variables? especialmente cómo acortar un nombre que es demasiado largo o qué tipo de abreviaciones usar?

Answer 1

¿Qué tal numEngineNames?

Elegir nombres de variables es más arte que ciencia. Quieres algo que no tome una época para escribir, pero lo suficiente como para ser expresivo. Es un equilibrio subjetivo.

Pregúntese, si alguien estuviera mirando el nombre de la variable por primera vez, ¿es razonablemente probable que esa persona comprenda su propósito?

Answer 2

Depende del alcance de la variable. Una variable local en una función corta generalmente no vale un "nombre perfecto", solo llámala engine_count o algo así. Por lo general, el significado será fácil de detectar, si no un comentario podría ser mejor que un nombre de variable de dos líneas.

variables de alcance más amplio - es decir, las variables globales (si son realmente necesario!), Las variables miembro - merecen mi humilde opinión, un nombre que es casi auto documental. Por supuesto, buscar la declaración original no es difícil y la mayoría de IDE lo hace automáticamente, pero el identificador de la variable no debería carecer de sentido (es decir, number o count).

Por supuesto, todo esto depende mucho de su estilo de codificación personal y las convenciones en su lugar de trabajo.

Answer 3

Un nombre es demasiado largo cuando existe un nombre más corto que transmite por igual el propósito de la variable.

Creo que engineCount estaría bien aquí. El número de nombres de motor es presumiblemente igual al número de motores.

Consulte la publicación de JaredPar.

Answer 4

Si se trata de una variable local en una función, probablemente lo llamaría n, o quizás ne. La mayoría de las funciones solo contienen dos o tres variables, por lo que un nombre largo es innecesario.

Answer 5

Depende de la vida útil o de los fines previstos. Sin embargo, eso incluye la vida del desarrollo. Recientemente nombré un vector "cosas" porque era solo para uso en un experimento.

Si una variable solo se declara o define justo al lado de su uso, entonces no me molestaría con un nombre expresivo. Si no, buscaría un nombre de talla médica. Nunca puedo entender por qué las personas usarían nombres, digamos, por encima de 10 caracteres. Algo como enames sería mi elección para tu pregunta.

Answer 6

depende del contexto, si su es una variable local, como por ejemplo

int num = text.scan(SEARCH_ENGINE_NAME).size(); 

el más explícito de la derecha de la expresión más corto es el nombre me quedaría. Lo racional es que estamos en un alcance limitado de quizás 4-5 líneas y, por lo tanto, podemos suponer que el lector podrá establecer la conexión entre el nombre corto y la expresión del lado derecho. Sin embargo, si es el campo de una clase, prefiero ser lo más detallado posible.

Answer 7

ver similares question

El primary technical imperative es reducir la complejidad. Las variables deben nombrarse para reducir la complejidad. A veces, esto da como resultado nombres más cortos, a veces nombres más largos. Por lo general, corresponde a lo difícil que es para un mantenedor comprender la complejidad del código.

En un extremo de los espectros, tiene para iteradores de bucle e índices. Estos pueden tener nombres como i o j, porque son así de simples y comunes. Darles nombres más largos solo causaría más confusión.

Si una variable se usa con frecuencia pero representa algo más complejo, debe darle un nombre claro para que el usuario no tenga que volver a aprender lo que significa cada vez que la usa.

En el otro extremo del espectro hay variables que se usan muy raramente. Todavía desea reducir la confusión aquí, pero darle un nombre corto es menos importante, porque la penalidad por volver a aprender el propósito de la variable no se paga con mucha frecuencia.

Answer 8

Al pensar en su código, intente verlo desde la perspectiva de otra persona. Esto ayudará no solo a elegir nombres, sino también a mantener su código legible como un todo.

Tener nombres de variables realmente largos complicará la legibilidad de su código, por lo que desea evitarlos. Pero en el otro extremo del espectro, querrás evitar nombres ultra cortos o acrónimos como "n" o "ne". Los nombres cortos y crípticos como estos harán que alguien intente leer su código para arrancarse el pelo. Por lo general, las variables de una o dos letras se usan para tareas pequeñas como, por ejemplo, incrementarse en un bucle for.

Así que lo que queda es un equilibrio entre estos dos extremos. "Num" es una abreviatura comúnmente utilizada, y cualquier programador semi-experimentado sabrá lo que quiere decir inmediatamente. Así que algo como "numEngines" o "numEngineNames" funcionaría bien. Además de esto, también puede poner un comentario en su código al lado de la variable la primera vez que se usa. Esto le permitirá al lector saber exactamente lo que está haciendo y ayudará a evitar cualquier posible confusión.

Answer 9

Lo llamaría "search_engine_count", porque contiene un recuento de los motores de búsqueda.

Answer 10

Uso Esc + _ + Esc a escribir:

this_is_a_long_variable = 42 

Esc + _ + Esc y _ no son caracteres idénticos en Mathematica. Es por eso que puedes usar lo primero pero no lo último.