¿Qué es un recurso para aprender a comentar y documentar el código? Me gustaría asegurarme de que el código sea “legible”.

En algunos lugares, leo que “el buen código está autodocumentado” tal vez, tal vez esto podría ser cierto. Solo si pones algunas directivas como:

Nombres significativos para clases, métodos / funciones, variables / constantes, argumentos / parámetros.

Tienes:

// esta clase es una clase ruda
clase pública Z {
public int x (int b, int c) {
retorno (b + c) / d; // ¿De dónde diablos tengo el valor ‘d’?
}
}

En su lugar puedes tener:

/ ** Esta clase calcula mis precios increíbles y promociones FTW; <-corto explicación de las responsabilidades de la clase * /

clase pública PriceCalculator {
promoción int estática = 14;
/ * devuelve un cálculo de precio en base de precio, interés y promoción * /
public int calculaEntirePriceWithoutDecimals (int priceNoDecimals, int interestNoDecimals) {
int total = (priceNoDecimals + interestNoDecimals) / promotion;
total de retorno
}
} // ¡Buen programador, toma una cookie!

Declare variables y asigne resultados de alguna operación, en lugar de obtener un resultado directo de una operación y pasar directamente a otra operación.

Tienes (como el ejemplo anterior):

devuelve a + b + c;

Tu puedes tener:

int result = firstPrice + promotionCode + interest;

Si tiene un código anterior que sabe qué resultado obtiene pero no sabe cómo funciona, puede agregar un comentario extenso para tener una idea completa de qué diablos está tratando. No dude en explicarlo extensamente cuando no esté seguro acerca de un código.

Eso fue por código.

Para el control de versiones, debe explicar qué es el código que escribe, una descripción general del código, o si toca el código de otra persona, debe agregar el motivo y, si hace una reparación de un boleto, debe agregar el Número del ticket (en el código también).

Solo recuerdo esos puntos, pero estoy bastante seguro de que pueden ayudarte a mejorar tu código 😉

Aclamaciones.