Convención de nomenclatura en C++

Nombrar un archivo o una variable es el primer y más básico paso que da un programador para escribir códigos limpios, donde el nombre debe ser apropiado para que cualquier otro programador actúe como una forma fácil de leer el código. En C++ , las convenciones de nomenclatura son el conjunto de reglas para elegir el nombre válido para una variable y función en un programa C++. 

• El nombre de la clase debe ser un sustantivo.
• Use letras mayúsculas como separadores de palabras, minúsculas para el resto de la palabra en el nombre de la clase.
• El primer carácter del nombre de la clase debe estar en mayúsculas.
• No se permiten guiones bajos (‘_’) en el nombre de la clase.
• El nombre del atributo privado en la clase debe ir precedido del carácter ‘m’.
• Después de anteponer ‘m’, se seguirán las mismas reglas para el nombre que para el nombre de la clase.
• El carácter ‘m’ también precede a otros modificadores de nombre. Por ejemplo, ‘p’ para punteros.
• Cada nombre de método/función debe comenzar con un verbo.
• El primer carácter de los nombres de argumentos de funciones/métodos debe estar en minúsculas. Todas las palabras que comienzan después de la primera letra deben estar en mayúsculas con los nombres de las clases.
• El nombre de la variable debe comenzar con un alfabeto.
• Se pueden usar dígitos en el nombre de la variable, pero solo después del alfabeto.
• No se pueden usar símbolos especiales en los nombres de las variables, excepto el guión bajo (‘_’).
• No se pueden utilizar palabras clave para nombres de variables.
• Las variables de puntero deben anteponerse con ‘p’ y colocar el asterisco ‘*’ cerca del nombre de la variable en lugar del tipo de puntero.
• Las variables de referencia deben ir precedidas de ‘r’. Esto ayuda a diferenciar entre el método que devuelve un objeto modificable y el mismo método que devuelve un objeto no modificable.
• Las variables estáticas deben ir precedidas de ‘s’.
• Las constantes globales deben estar todas en mayúsculas separadas por ‘_’.
• No se permite ningún carácter especial en el nombre del archivo excepto el guión bajo (‘_’) y el guión (‘-‘).
• El nombre del archivo debe terminar con la extensión .cc al final o debe terminar con la extensión .cpp.
• No utilice nombres de archivo que ya existan en /user/include. o cualquier nombre de archivo de encabezado predefinido.

Ejemplo:

Calcular el producto de dos variables-
Nombre de la variable 1 como var1
Nombre de la variable 2 como var2
Nombre del resultado como producto o pdt

Esta será una convención de nomenclatura más conveniente que asumir nombres aleatorios como x, y y z.

Ventajas de las convenciones de nomenclatura:

Seguir un conjunto de reglas en la convención de nomenclatura mientras se escribe el código ayuda de las siguientes maneras:

1. Evita conflictos de nombres.
2. Mejora la claridad del código en caso de ambigüedad.
3. Ayuda a formalizar y promover la consistencia dentro de un equipo.
4. Mejora la comprensión y legibilidad del código.

Ilustraciones:

1. Clase: nombre una clase en C++ por lo que es y use letras mayúsculas como separadores de palabras. El nombre de la clase debe ser un sustantivo. Por ejemplo, ReverseString, Multiply2Numbers. El nombre debe ser específico e insinuar el funcionamiento de la clase sin mirar el cuerpo de la clase. Este tipo de convenciones las llama PascalCase.
2. Métodos: cada método y función realiza una acción, por lo que el nombre de la función debe dejar claro lo que hace. Por ejemplo, writeDataToFile() es un nombre más conveniente que WriteFile(). Los nombres de funciones deben comenzar con un verbo. Este tipo de convenios se denominan camel case. También podemos seguir a snake_case para los métodos. En el caso de la serpiente, tenemos que unir dos palabras separadas usando ‘_’ (guión bajo).
3. Constantes: Las constantes deben estar todas en mayúsculas con separadores ‘_’. Por ejemplo, MAX_INT, TWO_PI, etc.

Convención de nomenclatura en C++

Los nombres en el programa son la clave para la legibilidad del programa. Si el nombre es apropiado en un programa, entonces todo encaja y las relaciones son claras, el significado es derivable. C++

CamelCase es una convención de nomenclatura en la que un nombre está formado por varias palabras que se unen como una sola palabra con la primera letra de cada palabra en mayúscula.

A continuación se muestran las convenciones de nomenclatura de la programación en C++. Deben seguirse mientras se escribe código en C++ para un buen mantenimiento, legibilidad y comprensión del programa.

Tipo 1: clases y nombres de atributos de clase

• El nombre de la clase debe ser un sustantivo.
• Use letras mayúsculas como separadores de palabras, minúsculas para el resto de la palabra.
• El primer carácter del nombre de la clase debe estar en mayúsculas.
• No se permiten guiones bajos (‘_’) en el nombre de la clase.

clase PerímetroRectángulo

clase Escáner de huellas dactilares

• El nombre del atributo privado en la clase debe ir precedido del carácter ‘m’.
• Después de anteponer ‘m’, se seguirán las mismas reglas para el nombre que para el nombre de la clase.
• El carácter ‘m’ también precede a otros modificadores de nombre. Por ejemplo, ‘p’ para punteros.

class PerimeterRectangle
{
    public:
    int perimetro;
    privado:
    longitud int;
    int mAncho;
}

Tipo 2: funciones y nombres de argumentos de función

Por lo general, cada función en C++ realiza una o más acciones, por lo que el nombre de la función debe indicar claramente lo que hace. Cada nombre de método/función debe comenzar con un verbo.

• Los sufijos son a veces útiles. Por ejemplo,
  • Count- el conteo actual del contador.
  • Clave: el valor de la clave.
• Los prefijos a veces son útiles. Por ejemplo,
  • obtener- obtener valor.
  • establecer- establecer valor.

 Se utiliza la misma convención de nombres que para los nombres de las clases.

int obtenerValor();

int ResolverEcuación();

El primer carácter de los nombres de argumentos de funciones/métodos debe estar en minúsculas. Todas las palabras que comienzan después de la primera letra deben estar en mayúsculas con los nombres de las clases.

int PerimeterRectangle(int lengthRectangle, int widthRectangle)

Tipo 3: Variables

Cuando las variables se declaran dinámicamente usando la nueva palabra clave o si las variables se declaran como atributos de clase, toman memoria del montón y cuando las variables se crean en un programa C++, la memoria se asigna desde la pila del programa.

• El nombre de la variable debe comenzar con un alfabeto.
• Se pueden usar dígitos, pero solo después del alfabeto.
• No se pueden usar símbolos especiales en los nombres de las variables, excepto el guión bajo (‘_’).
• No se pueden utilizar palabras clave para nombres de variables.

int costo_total;

longitud int;

Las variables de puntero deben anteponerse con ‘p’ y colocar el asterisco ‘*’ cerca del nombre de la variable en lugar del tipo de puntero.

int *pNombre;

int *página, dirección; // Aquí solo pAge es una variable de puntero

Las variables de referencia deben ir precedidas de ‘r’. Esto ayuda a diferenciar entre el método que devuelve un objeto modificable y el mismo método que devuelve un objeto no modificable.

Las variables estáticas deben ir precedidas de ‘s’.

cuenta int estática;

Tipo 4: Constante

Las constantes globales deben estar todas en mayúsculas separadas por ‘_’.

constante doble DOS_PI = 6.28318531; 

Tipo 5: Nombre de archivo;

• No se permite ningún carácter especial en el nombre del archivo excepto el guión bajo (‘_’) y el guión (‘-‘).
• El nombre del archivo debe terminar con la extensión .cc al final o debe terminar con la extensión .cpp.
• No utilice nombres de archivo que ya existan en /user/include. o cualquier nombre de archivo de encabezado predefinido.

holamundo.c // Válido

hola_mundo.cpp // Válido

 hola-mundo.cpp // Válido

hel-lo_world.cpp // Válido

hola* mundo.cpp // No válido

iostream.cpp // No válido