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




get codigo (24)

Ú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. .

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?


Cuando tiene un método grande o bloques de código, es conveniente saber de inmediato si usa una variable local o un miembro. ¡es para evitar errores y para una mejor claridad!


La razón principal para un prefijo miembro es distinguir entre una función miembro local y una variable miembro con el mismo nombre. Esto es útil si usa getters con el nombre de la cosa.

Considerar:

class person
{
public:
    person(const std::string& full_name)
        : full_name_(full_name)
    {}

    const std::string& full_name() const { return full_name_; }
private:
    std::string full_name_;
};

La variable miembro no se podría llamar nombre completo en este caso. Necesita cambiar el nombre de la función miembro a get_full_name () o decorar la variable miembro de alguna manera.


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.


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


Prefiero los guiones bajos de postfix, como los siguientes:

class Foo
{
   private:
      int bar_;

   public:
      int bar() { return bar_; }
};

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.


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;
}

No puedo decir qué tan amplio es, pero hablando personalmente, siempre (y siempre) he puesto como prefijo mis variables de miembro con 'm'. P.ej:

class Person {
   .... 
   private:
       std::string mName;
};

Es la única forma de prefijo que uso (soy notación muy anti-húngara) pero me ha sido muy útil a lo largo de los años. Como comentario adicional, generalmente detesto el uso de caracteres de subrayado en los nombres (o en cualquier otro lugar), pero hago una excepción para los nombres de macro del preprocesador, ya que generalmente están en mayúsculas.


It is useful to differentiate between member variables and local variables due to memory management. Broadly speaking, heap-allocated member variables should be destroyed in the destructor, while heap-allocated local variables should be destroyed within that scope. Applying a naming convention to member variables facilitates correct memory management.


Otros intentan hacer cumplir el uso de este miembro> siempre que se usa una variable miembro

Eso es usualmente porque no hay prefijo . El compilador necesita suficiente información para resolver la variable en cuestión, ya sea un nombre único debido al prefijo o mediante la palabra clave this .

Entonces, sí, creo que los prefijos aún son útiles. Yo, por mi parte, preferiría escribir '_' para acceder a un miembro en lugar de 'this->'.


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.


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.

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 ++?


According to JOINT STRIKE FIGHTER AIR VEHICLE C++ CODING STANDARDS (december 2005):

AV Rule 67

Public and protected data should only be used in structs—not classes. Rationale: A class is able to maintain its invariant by controlling access to its data. However, a class cannot control access to its members if those members non-private. Hence all data in a class should be private.

Thus, the "m" prefix becomes unuseful as all data should be private.

Pero es una buena costumbre usar el prefijo p antes de un puntero ya que es una variable peligrosa.


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.


Code Complete recommends m_varname for member variables.

While I've never thought the m_ notation useful, I would give McConnell's opinion weight in building a standard.


I like variable names to give only a meaning to the values they contain, and leave how they are declared/implemented out of the name. I want to know what the value means, period. Maybe I've done more than an average amount of refactoring, but I find that embedding how something is implemented in the name makes refactoring more tedious than it needs to be. Prefixes indicating where or how object members are declared are implementation specific.

color = Red;

Most of the time, I don't care if Red is an enum, a struct, or whatever, and if the function is so large that I can't remember if color was declared locally or is a member, it's probably time to break the function into smaller logical units.

If your cyclomatic complexity is so great that you can't keep track of what is going on in the code without implementation-specific clues embedded in the names of things, most likely you need to reduce the complexity of your function/method.

Mostly, I only use 'this' in constructors and initializers.


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). :-)


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.


In python leading double underscores are used to emulate private members. For more details see this answer


Algunas respuestas se centran en refactorizar, en lugar de nombrar convenciones, como la forma de mejorar la legibilidad. No siento que uno pueda reemplazar al otro.

Conozco programadores que no se sienten cómodos con el uso de declaraciones locales; prefieren colocar todas las declaraciones en la parte superior de un bloque (como en C), para que sepan dónde encontrarlas. Descubrí que, cuando el alcance lo permite, declarar las variables donde se usan por primera vez disminuye el tiempo que paso mirando hacia atrás para encontrar las declaraciones. (Esto es cierto incluso para pequeñas funciones). Eso me facilita comprender el código que estoy viendo.

Espero que esté suficientemente claro cómo esto se relaciona con las convenciones de nombres de los miembros: cuando los miembros tienen un prefijo uniforme, nunca tengo que mirar hacia atrás en absoluto; Sé que la declaración ni siquiera se encontrará en el archivo fuente.

Estoy seguro de que no comencé a preferir estos estilos. Sin embargo, con el tiempo, al trabajar en entornos en los que se usaban de manera constante, optimicé mi pensamiento para aprovecharlos. Creo que es posible que mucha gente que actualmente se sienta incómoda con ellos también los prefiera, dado el uso constante.


Our project has always used "its" as a prefix for member data, and "the" as a prefix for parameters, with no prefix for locals. It's a little cutesy, but it was adopted by the early developers of our system because they saw it used as a convention by some commercial source libraries we were using at the time (either XVT or RogueWave - maybe both). So you'd get something like this:

void
MyClass::SetName(const RWCString &theName)
{
   itsName = theName;
}

The big reason I see for scoping prefixes (and no others - I hate Hungarian notation) is that it prevents you from getting into trouble by writing code where you think you're referring to one variable, but you're really referring to another variable with the same name defined in the local scope. It also avoids the problem of coming up with a variable names to represent that same concept, but with different scopes, like the example above. In that case, you would have to come up with some prefix or different name for the parameter "theName" anyway - why not make a consistent rule that applies everywhere.

Just using this-> isn't really good enough - we're not as interested in reducing ambiguity as we are in reducing coding errors, and masking names with locally scoped identifiers can be a pain. Granted, some compilers may have the option to raise warnings for cases where you've masked the name in a larger scope, but those warnings may become a nuisance if you're working with a large set of third party libraries that happen to have chosen names for unused variables that occasionally collide with your own.

As for the its/the itself - I honestly find it easier to type than underscores (as a touch typist, I avoid underscores whenever possible - too much stretching off the home rows), and I find it more readable than a mysterious underscore.


Eso es solo una convención. El lenguaje Javascript no da ningún significado especial a los identificadores que comienzan con caracteres de subrayado.

Dicho esto, es una convención bastante útil para un lenguaje que no admite la encapsulation para usar. Aunque no hay forma de evitar que alguien abuse de las implementaciones de sus clases, al menos sí aclara su intención, y documenta dicho comportamiento como incorrecto en primer lugar.





c++ coding-style naming-conventions