c++ programacion - ¿Por qué usar prefijos en variables miembro en clases de C ++?




14 Answers

Tienes que tener cuidado con el uso de un guion bajo. Un subrayado inicial antes de una letra mayúscula en una palabra está reservado. Por ejemplo:

_Foo

_L

son todas palabras reservadas mientras

_foo

_l

no son. Hay otras situaciones en las que no se permiten subrayados iniciales antes de letras minúsculas. En mi caso específico, descubrí que el _L pasó a estar reservado por Visual C ++ 2005 y el choque creó algunos resultados inesperados.

Estoy al margen de lo útil que es marcar las variables locales.

Aquí hay un enlace sobre qué identificadores están reservados: ¿Cuáles son las reglas sobre el uso de un guión bajo en un identificador de C ++?

get codigo

Una gran cantidad de código C ++ utiliza convenciones sintácticas para marcar las variables de miembro. Ejemplos comunes incluyen

  • m_ memberName para miembros públicos (donde se usan miembros públicos)
  • _ memberName para miembros privados o todos los miembros

Otros intentan hacer cumplir el uso de este miembro cuando se usa una variable miembro.

En mi experiencia, la mayoría de las bases de códigos más grandes fallan en la aplicación de tales reglas consistentemente.

En otros idiomas, estas convenciones están mucho menos extendidas. Lo veo solo ocasionalmente en código Java o C #. Creo que nunca lo he visto en el código de Ruby o Python. Por lo tanto, parece que hay una tendencia en los lenguajes más modernos de no usar marcado especial para las variables miembro.

¿Es esta convención todavía útil hoy en C ++ o es simplemente un anacronismo? Especialmente ya que se usa de forma tan inconsistente en las bibliotecas. ¿No han demostrado los otros idiomas que uno puede prescindir de los prefijos de los miembros?




Por lo general, no uso un prefijo para las variables miembro.

Solía ​​usar un prefijo m , hasta que alguien señaló que "C ++ ya tiene un prefijo estándar para el acceso de miembros: this-> .

Entonces eso es lo que uso ahora. Es decir, cuando hay ambigüedad , agrego el prefijo this-> , pero generalmente no existe ambigüedad, y puedo referirme directamente al nombre de la variable.

Para mí, eso es lo mejor de ambos mundos. Tengo un prefijo que puedo usar cuando lo necesito, y soy libre de omitirlo siempre que sea posible.

Por supuesto, el obvio contra esto es "sí, pero luego no se puede ver a simple vista si una variable es un miembro de la clase o no".

A lo que les digo "¿y qué? Si necesitas saber eso, tu clase probablemente tiene demasiado estado o la función es demasiado grande y complicada".

En la práctica, he descubierto que esto funciona extremadamente bien. Como una ventaja adicional, me permite promocionar una variable local a un miembro de la clase (o al revés) fácilmente, sin tener que cambiarle el nombre.

¡Y lo mejor de todo, es consistente! No tengo que hacer nada especial ni recordar ninguna convención para mantener la coherencia.

Por cierto, no debes usar guiones bajos principales para los miembros de tu clase. Te acercas incómodamente a los nombres que están reservados por la implementación.

El estándar reserva todos los nombres comenzando con doble guión bajo o guión bajo seguido de letra mayúscula. También reserva todos los nombres comenzando con un único guión bajo en el espacio de nombres global .

Por lo tanto, un miembro de la clase con un guión bajo seguido de una letra minúscula es legal, pero tarde o temprano harás lo mismo con un identificador que comience con mayúsculas o que de otra forma rompa una de las reglas anteriores.

Por lo tanto, es más fácil simplemente evitar los guiones bajos principales. Use un guión bajo postfijo, o un prefijo m_ o solo m si desea codificar el alcance en el nombre de la variable.




Últimamente he tendido a preferir el prefijo m_ en lugar de no tener ningún prefijo, las razones no es tanto que sea importante marcar las variables miembro, sino que evita la ambigüedad, digamos que tienes un código como:

void set_foo(int foo) { foo = foo; }

El de causa no funciona, solo se permite un foo . Entonces tus opciones son:

  • this->foo = foo;

    No me gusta, ya que causa sombreado de parámetros, ya no se pueden usar las advertencias g++ -Wshadow , también es más largo para escribir luego m_ . También se encuentra con conflictos de nombres entre variables y funciones cuando tiene un int foo; y un int foo(); .

  • foo = foo_; o foo = arg_foo;

    He estado usando eso por un tiempo, pero hace que las listas de argumentos sean desagradables, la documentación no debería tener que ver con la desambigüedad de nombres en la implementación. Los conflictos de nombres entre variables y funciones también existen aquí.

  • m_foo = foo;

    La documentación de la API se mantiene limpia, no obtienes ambigüedad entre las funciones y variables de los miembros, y es más corta para escribir, luego this-> . La única desventaja es que hace que las estructuras POD sean feas, pero como las estructuras POD no sufren la ambigüedad del nombre en primer lugar, no es necesario usarlo con ellas. Tener un prefijo único también facilita algunas operaciones de búsqueda y reemplazo.

  • foo_ = foo;

    La mayoría de las ventajas de m_ aplican, pero la rechazo por razones estéticas, un guión bajo final o posterior simplemente hace que la variable parezca incompleta y desequilibrada. m_ solo se ve mejor. Usar m_ también es más extensible, ya que puedes usar g_ para globales y s_ para estática.

PD: La razón por la que no ves m_ en Python o Ruby es porque ambos lenguajes imponen su propio prefijo, Ruby usa @ para las variables de miembro y Python requiere self. .




Al leer a través de una función miembro, saber quién es el "propietario" de cada variable es absolutamente esencial para comprender el significado de la variable. En una función como esta:

void Foo::bar( int apples )
{
    int bananas = apples + grapes;
    melons = grapes * bananas;
    spuds += melons;
}

... es bastante fácil ver de dónde vienen las manzanas y los plátanos, pero ¿qué pasa con las uvas, los melones y las papas fritas? ¿Deberíamos buscar en el espacio de nombres global? En la declaración de clase? ¿La variable es miembro de este objeto o miembro de la clase de este objeto? Sin saber la respuesta a estas preguntas, no puedes entender el código. Y en una función más larga, incluso las declaraciones de variables locales como manzanas y plátanos pueden perderse en la mezcla.

El anteponer una etiqueta consistente para variables globales, variables de miembros y miembros estáticos (quizás g_, m_ y s_ respectivamente) aclara instantáneamente la situación.

void Foo::bar( int apples )
{
    int bananas = apples + g_grapes;
    m_melons = g_grapes * bananas;
    s_spuds += m_melons;
}

Puede que les cueste acostumbrarse un poco al principio, pero ¿qué ocurre con la programación? Hubo un día en que incluso {y} te pareció extraño. Y una vez que te acostumbras, te ayudan a entender el código mucho más rápido.

(Usar "this->" en lugar de m_ tiene sentido, pero es aún más prolijo y visualmente disruptivo. No lo veo como una buena alternativa para marcar todos los usos de las variables miembro).

Una posible objeción al argumento anterior sería extender el argumento a los tipos. También podría ser cierto que conocer el tipo de una variable "es absolutamente esencial para comprender el significado de la variable". Si eso es así, ¿por qué no agregar un prefijo a cada nombre de variable que identifica su tipo? Con esa lógica, terminas con notación húngara. Pero muchas personas encuentran que la notación húngara es laboriosa, fea e inútil.

void Foo::bar( int iApples )
{
    int iBananas = iApples + g_fGrapes;
    m_fMelons = g_fGrapes * iBananas;
    s_dSpuds += m_fMelons;
}

El húngaro nos dice algo nuevo sobre el código. Ahora comprendemos que hay varias conversiones implícitas en la función Foo :: bar (). El problema con el código ahora es que el valor de la información agregada por los prefijos húngaros es pequeña en relación con el costo visual. El sistema de tipo C ++ incluye muchas características para ayudar a que los tipos funcionen bien juntos o para generar una advertencia o error en el compilador. El compilador nos ayuda a manejar los tipos; no necesitamos notación para hacerlo. Podemos inferir con bastante facilidad que las variables en Foo :: bar () son probablemente numéricas, y si eso es todo lo que sabemos, eso es lo suficientemente bueno para obtener una comprensión general de la función. Por lo tanto, el valor de conocer el tipo exacto de cada variable es relativamente bajo. Sin embargo, la fealdad de una variable como "s_dSpuds" (o incluso simplemente "dSpuds") es genial. Entonces, un análisis de costo-beneficio rechaza la notación húngara, mientras que el beneficio de g_, s_, y m_ abruma el costo a los ojos de muchos programadores.




No creo que una sintaxis tenga valor real sobre otra. Todo se reduce, como mencionaste, a la uniformidad en todos los archivos fuente.

El único punto donde encuentro tales reglas interesantes es cuando necesito 2 cosas nombradas idénticamente, por ejemplo:

void myFunc(int index){
  this->index = index;
}

void myFunc(int index){
  m_index = index;
}

Lo uso para diferenciar los dos. Además, cuando envuelvo las llamadas, como desde Windows Dll, RecvPacket (...) desde el Dll podría estar envuelto en RecvPacket (...) en mi código. En estas ocasiones en particular, el uso de un prefijo como "_" puede hacer que los dos se vean iguales, fácil de identificar cuál es cuál, pero diferente para el compilador




Esas convenciones son solo eso. La mayoría de las tiendas usan convenciones de códigos para facilitar la lectura del código, de modo que cualquier persona puede ver fácilmente un fragmento de código y descifrar rápidamente cosas como miembros públicos y privados.




Otros lenguajes utilizarán convenciones de codificación, simplemente tienden a ser diferentes. C #, por ejemplo, probablemente tenga dos estilos diferentes que las personas tienden a usar, ya sea uno de los métodos C ++ (_variable, mVariable u otro prefijo como la notación húngara), o lo que yo llamo el método StyleCop.

private int privateMember;
public int PublicMember;

public int Function(int parameter)
{
  // StyleCop enforces using this. for class members.
  this.privateMember = parameter;
}

Al final, se convierte en lo que la gente sabe y lo que se ve mejor. Personalmente creo que el código es más legible sin notación húngara, pero puede ser más fácil encontrar una variable con intellisense, por ejemplo, si se adjunta la notación húngara.

En mi ejemplo anterior, no necesita un prefijo m para las variables miembro porque prefija su uso con esto. indica lo mismo en un método aplicado por el compilador.

Esto no necesariamente significa que los otros métodos son malos, las personas se apegan a lo que funciona.




OMI, esto es personal. No estoy poniendo ningún prefijo en absoluto. De todos modos, si se dice que el código es público, creo que debería tener algunos prefijos, por lo que puede ser más legible.

A menudo, las grandes empresas están usando sus propias 'reglas de desarrollador'.
Por cierto, el más divertido y más inteligente que vi fue DRY KISS (no repetir, manténlo simple, estúpido). :-)




The original idea for prefixes on C++ member variables was to store additional type information that the compiler didn't know about. So for example, you could have a string that's a fixed length of chars, and another that's variable and terminated by a '\0'. To the compiler they're both char * , but if you try to copy from one to the other you get in huge trouble. So, off the top of my head,

char *aszFred = "Hi I'm a null-terminated string";
char *arrWilma = {'O', 'o', 'p', 's'};

where "asz" means this variable is "ascii string (zero-terminated) and "arr" means this variable is a character array.

Then the magic happens. The compiler will be perfectly happy with this statement:

strcpy(arrWilma, aszFred);

But you, as a human, can look at it and say "hey, those variables aren't really the same type, I can't do that".

Unfortunately a lot places use standards such as "m_" for member variables, "i" for integers no matter how used, "cp" for char pointers. In other words they're duplicating what the compiler knows, and making the code hard to read at the same time. I believe this pernicious practice should be outlawed by statute and subject to harsh penalties.

Finally, there's two points I should mention:

  • Judicious use of C++ features allows the compiler to know the information you had to encode in raw C-style variables. You can make classes that will only allow valid operations. This should be done as much as practical.
  • If your code blocks are so long that you forget what type a variable is before you use it, they are way too long. Don't use names, re-organize.



I think that, if you need prefixes to distinguish class members from member function parameters and local variables, either the function is too big or the variables are badly named. If it doesn't fit on the screen so you can easily see what is what, refactor.

Given that they often are declared far from where they are used, I find that naming conventions for global constants (and global variables, although IMO there's rarely ever a need to use those) make sense. But otherwise, I don't see much need.

That said, I used to put an underscore at the end of all private class members. Since all my data is private, this implies members have a trailing underscore. I usually don't do this anymore in new code bases, but since, as a programmer, you mostly work with old code, I still do this a lot. I'm not sure whether my tolerance for this habit comes from the fact that I used to do this always and am still doing it regularly or whether it really makes more sense than the marking of member variables.




I use it because VC++'s Intellisense can't tell when to show private members when accessing out of the class. The only indication is a little "lock" symbol on the field icon in the Intellisense list. It just makes it easier to identify private members(fields) easier. Also a habit from C# to be honest.

class Person {
   std::string m_Name;
public:
   std::string Name() { return m_Name; }
   void SetName(std::string name) { m_Name = name; }
};

int main() {
  Person *p = new Person();
  p->Name(); // valid
  p->m_Name; // invalid, compiler throws error. but intellisense doesn't know this..
  return 1;
}



I almost never use prefixes in front of my variable names. If you're using a decent enough IDE you should be able to refactor and find references easily. I use very clear names and am not afraid of having long variable names. I've never had trouble with scope either with this philosophy.

The only time I use a prefix would be on the signature line. I'll prefix parameters to a method with _ so I can program defensively around them.




You should never need such a prefix. If such a prefix offers you any advantage, your coding style in general needs fixing, and it's not the prefix that's keeping your code from being clear. Typical bad variable names include "other" or "2". You do not fix that with requiring it to be mOther, you fix it by getting the developer to think about what that variable is doing there in the context of that function. Perhaps he meant remoteSide, or newValue, or secondTestListener or something in that scope.

It's an effective anachronism that's still propagated too far. Stop prefixing your variables and give them proper names whose clarity reflects how long they're used. Up to 5 lines you could call it "i" without confusion; beyond 50 lines you need a pretty long name.




I use m_ for member variables just to take advantage of Intellisense and related IDE-functionality. When I'm coding the implementation of a class I can type m_ and see the combobox with all m_ members grouped together.

But I could live without m_ 's without problem, of course. It's just my style of work.




Related

c++ coding-style naming-conventions