Ingeniería de Software: No recuerdo código. ¿Cómo puedo recordar el código de programación fácilmente?

Answer 1

Un pequeño secreto: ¡ Nadie es capaz de recordar su código! Después de 25 años en el negocio de la ingeniería de software, tengo la suerte de recordar en detalle lo que escribí antes del almuerzo si no cumplo con las siguientes recomendaciones.

Es por eso que tenemos algo llamado estilo y legibilidad; No es solo por el aspecto.

¿Alguna vez te has preguntado por qué siempre ves un código bien sangrado, marcado por diferentes colores, marcado por buenos nombres de variables, comentarios, etc.? QUE NO ES PARA LA MÁQUINA; Es para el programador.

La máquina podría dar un si llamamos a una variable “doctor” (para guardar el nombre de un doctor). La máquina no parpadearía ni un ojo si llamáramos la misma variable “xx” o incluso “fckYou”. A la máquina no le importa. No me importa si hago sangría, no me importa si hago comentarios.

Todo eso es para mí, el programador de carne y hueso.

Vea la respuesta de Marcas Neal a ¿Qué tan común es que los programadores usen malas palabras en los nombres de variables?

Tome el siguiente código, por ejemplo … dime cuál es más fácil de leer:

/ **
* Crear una nueva parte de mimo.
*
* @param in – el flujo de entrada para leer la parte de
* @param partSuffix – la cadena que debe terminar cada parte
* @param filePrefix: el prefijo de los archivos guardados que se encuentran en la parte
* /
MimePart público (entrada de InputStream, String partSuffix, String filePrefix)
lanza IOException
{
this.partSuffix = partSuffix;
this.in = in;
headers = new HashMap ();

ByteArrayOutputStream arrayOut = new ByteArrayOutputStream ();

mientras (verdadero)
{
MimeUtils.copyUntilLineBreak (in, arrayOut);
String s = new String (arrayOut.toByteArray ());

if (s.trim (). length () == 0)
descanso;

MimeHeader hdr = nuevo MimeHeader (s);
headers.put (hdr.getKey (), hdr);

arrayOut.reset ();
}

o

public BamBam (InputStream xxx, String funnyName, String x234234XX) lanza IOException {this.xxx = xxx; this.funnyName = funnyName; bamBam = new HashMap ();

Sugerencia : ambas piezas de código hacen exactamente lo mismo, y el segundo es mi intento de hacer que el primero sea ilegible para un humano, no para una máquina.

Por lo tanto, para hacer que su código sea más fácil de entender y, por lo tanto, más fácil de recordar, use un buen estilo. Por cierto, el estilo también forma parte de la ingeniería de software, debido a la primera ley de la ingeniería de software: los errores son un hecho de la vida. ¡Acostúmbrate!

Como ingeniero de software, su trabajo es asegurarse de que los errores sean menos frecuentes y causen menos daño * CUANDO * inevitablemente aparezcan, sabiendo que es imposible evitarlos por completo.