Cómo escribir código limpio en C ++

Directrices de código limpio

Al codificar, el estilo de codificación que sigue puede ser realmente importante. Especialmente cuando está trabajando con un equipo o planea compartir su código.

La mayoría de estas pautas son estándar y se pueden aplicar a la mayoría de los lenguajes de programación. Sin embargo, aquí tienes aplicaciones y fragmentos con código C ++, para que puedas familiarizarte con él más fácilmente.

Recuerde que estas son solo recomendaciones para lograr claridad, que puede ser una preferencia personal. Así que tenga en cuenta estos consejos, pero no los tome al pie de la letra. A veces, romper algunas de estas reglas puede conducir a un código más limpio.

Use buenos nombres de variables y haga comentarios

Asegúrese de crear buenos nombres de variables. Por ejemplo, si está creando un juego, evite usar la variable "a" y en su lugar use algo como "p1" cuando se refiera al jugador 1.

La notación húngara se usa comúnmente y puede darle algunas pautas para declarar variables.

Además, POR FAVOR, use comentarios. No es broma, solo intente leer algunos proyectos antiguos que hizo sin comentarios ... ahora imagine ser otra persona que ni siquiera lo codificó.

Variables globales

Las variables globales pueden ser fáciles de usar y, cuando solo trabaja con un pequeño código, puede parecer una gran solución. Pero cuando el código se hace más y más grande, se vuelve más difícil saber cuándo se están utilizando.

En lugar de usar variables globales, puede usar variables declaradas en funciones. Esto puede ayudarlo a saber qué valores se están transmitiendo para que pueda identificar los errores más rápidamente.

#include  using namespace std; // Global variables are declared outside functions int cucumber; // global variable "cucumber"

Usando goto, continue, etc.

Esta es una discusión común entre los programadores. Al igual que las variables globales, este tipo de declaraciones generalmente se considera una mala práctica. Se consideran malos porque conducen a "código spaguetti".

Cuando programamos queremos un flujo lineal. Pero cuando se usan esas declaraciones, el flujo se modifica y conduce a un flujo "retorcido y enredado".

Goto se utilizó en el pasado. Pero cuando aparecieron las funciones while, for, if, sin embargo, con la introducción de esas se creó la programación estructurada. En general, evite usar goto a menos que esté seguro de que hará que su código sea más limpio y más fácil de leer. Un ejemplo podría ser usarlo en bucles anidados.

El uso de romper y continuar es prácticamente el mismo. Úselos en interruptores e intente hacer funciones con un propósito para que solo tenga un punto de salida.

img

Evite cambiar la variable de control dentro de un bucle for

Por lo general, existen soluciones alternativas para evitar esto que parecen más claras y menos confusas, por ejemplo. while bucles. Hacer esto:

int i=1; while (i <= 5) { if (i == 2) i = 4; ++i; }

En vez de:

for (int i = 1; i <= 5; i++) { if (i == 2) { i = 4; } // Do work }

Declare constantes y tipos en la parte superior

Por lo general, se declaran después de las bibliotecas. Esto los agrupa y los hace más fáciles de leer. Para las variables locales es lo mismo: declararlas en la parte superior (otras personas prefieren declararlas lo más tarde posible para ahorrar memoria, ver: cplusplus.com).

Use solo una función de retorno al final

Como dije antes, tiendo a hacer una sola entrada y salida para que el flujo sea más claro.

Use llaves incluso al escribir frases ingeniosas

Hacer esto sistemáticamente le ayudará a hacerlo más rápido. Y en caso de que quieras cambiar el código en el futuro podrás hacerlo sin preocupaciones.

En vez de:

for (int i = 1; i <= 5; i++) //CODE

Hacer esto:

for (int i = 1; i <= 5; i++) { //CODE }

Otras recomendaciones

Úselo forcuando sepa el número de iteraciones, pero use whiley do whilecuando no lo sepa .

Utilice const, pase por valor / referencia cuando sea adecuado. Esto ayudará a ahorrar memoria.

Escriba constante en mayúsculas, tipos de datos que comiencen con T y variables en minúsculas.

const int MAX= 100; //Constant typedef int TVector[MAX]; //Data type TVector vector; //Vector