Características de un código limpio

Los programadores o desarrolladores suelen escribir códigos para su proyecto o para algunas empresas. O algunos comienzan a escribir código como principiantes en el mundo de la programación. En todos estos escenarios, llega un momento nostálgico cuando revisas tu código después de mucho tiempo. Encuentras tu propio código tan difícil de entender. Aquí hay algunas buenas prácticas o las características de un código limpio que debe seguir:

1. Convenciones de nomenclatura: Esta es una práctica muy básica a seguir. Los nombres correctos de las variables y funciones son muy importantes. Supongamos que alguien va a verificar su código, entonces debería poder entender el código de un vistazo.

• Se deben nombrar las variables según el dominio del proyecto.
• Se debe usar ‘es’ como prefijo de las variables booleanas.

Ejemplo: Suponga que está creando una aplicación bancaria o algo que tenga que ver con el pago.

double totalBalance;        // Represents the user account balance

double amountToDebit;      // Represents the amount to charge the user

double amountToCredit;    // Represents the amount to give to the user

boolean isUserActive;

Uno debe seguir:

• Camel Case para variables y estructuras de datos.

  Ejemplo:

  String  merchantName = "John Perry";
  
  int  integerArray[] = new int[10];
  

• Estuche Screaming Snake para Constants.

  Ejemplo:

  final long ACCOUNT_NUMBER = 123456;

2. Se trata de métodos/funciones

“Cuantos más métodos útiles escriba, mejor programador será”
– Mitch Tabian, CodingWithMitch

• Use Camel Case para nombrar funciones.
• Nombra las funciones en los sonidos del verbo-sustantivo.
• El corchete de apertura del método debe estar en la misma línea que el nombre del método.
• La función solo debe aceptar 1 o 2 argumentos, no más que eso.

Ejemplo:

double getUserBalance(long int accountNumber) {

// Method Defination

}

3. Estructura de archivos: Es muy importante mantener la estructura del proyecto. Esto lo hace muy limpio y más comprensible. La estructura difiere del desarrollo web al desarrollo móvil, pero la idea sigue siendo la misma.

Ejemplo:

4. Sangría: A veces escribes algún código y ese código está compuesto dentro de otro o puedes decir el código anidado. Esta composición es muy difícil de clasificar y diferenciar no es fácil. Así que es mejor usar sangría. Significa poner los soportes en el lugar correcto.

5. Registro: cuando se trata de escribir código, no significa que solo escriba el código y lo compile con éxito. Está lejos de la verdad que algún día o muchas veces tendrás que depurar. Escribir declaraciones de registro lo ayuda en esos momentos terribles. Escribir declaraciones de registro en funciones es una excelente opción. La mayor parte del procesamiento se realiza a través de la función, por lo que tener una declaración de registro allí significa que podemos obtener una indicación del éxito y el fracaso.

6. Evitar los comentarios que se explican por sí mismos: a todos nos gusta agregar el comentario alrededor del código. En una nota importante, debemos evitar los comentarios que se explican por sí mismos, ya que consumen mucho tiempo y son inútiles. Uno debe escribir un código que se explique a sí mismo.

Ejemplo:

final double PI = 3.14; // This is pi value //

El comentario de la declaración anterior no es necesario. Así que evita esta práctica.