Imagine una sola cosa que hará que su código sea más comprensible, y también lo ayudará a comprender el código de otra persona mucho más fácilmente y menos "desordenará" el código de otra persona que se escribió antes de unirse a la empresa. Y lo mejor es que siempre comprenderá si vale la pena cambiarlo o mejor no tocarlo. Presentado?
El comienzo es demasiado prometedor y ya has sentido algún tipo de divorcio.
Ahora en serio.
Escribo código para mí mismo en mi propio proyecto y en una empresa donde programo más de uno. Y comencé a notar que incluso cuando trabajo solo y regreso a la sección anterior del código, hay pensamientos: "¿Por qué escribí así aquí, está mal?" Y de repente, si quiero cambiar, entonces puede surgir una situación en la que algo funciona mal y la decisión que tomé cuando escribí ese código antiguo fue óptima.
Por lo tanto, es importante escribir en los comentarios "¿Por qué", "¿Por qué tomé esa decisión cuando programé?", "¿Por qué de todas las opciones elegí exactamente la implementación en la que me detuve?". Especialmente si trabajas en equipo. Tuve una situación en la que el fragmento de código que otra persona escribió no implementó completamente lo que necesitaba y ahora tengo una pregunta lógica: "¿Por qué hizo esto?", Pero no podemos recordar todo y lógicamente recibí la respuesta: " No recuerdo por qué. Algo no creció juntos allí ". Y te encuentras en una situación de estancamiento, la opción que ahora está disponible y, por otro lado, teme comenzar a reescribirte, porque no sabes de dónde vendrá el problema, tal vez encuentres el mismo problema insoluble que tu colega enfrentó, o tal vez no . ¿Quién sabe esto ahora? Y esto lleva al hecho de que algunas partes del código se vuelven "intocables", tiene miedo de tocarlas.
Así que creo que escribir la razón para elegir una opción da ciertos bonos.
- Incluso cuando trabaja solo, puede entender de inmediato si conoce el motivo. Se quedó boquiabierto cuando escribió este código o es un código adecuado, dado el contexto.
- Creces como programador y puedes cambiar la decisión que una vez tomaste por inexperiencia, porque sabes por qué está aquí.
- Con el tiempo, la razón por la que se escribe ese código puede "hundirse en el olvido" y ahora, cuando vea esto, comprenderá que puede deshacerse de él con una mente tranquila, si no lo escribe, permanecerá aquí, Miedo de lastimar algo.
- Puede mirar el antiguo código escrito antes que usted de una nueva manera. Si antes, con una mirada arrogante, lo escudriñaste, ahora entiendes que en la situación que los programadores estaban antes que tú, esta fue una decisión muy correcta.
- Salvas de la situación cuando limpias, la decisión de la muleta que tenía antes, y resulta que abriste la caja de pandora, porque solo esta muleta se contuvo de la muerte universal.
- Cuando escriba por qué, otro desarrollador que vea esto podrá reescribir, sabiendo cómo resolver el problema que resolvió de manera más efectiva.
En conclusión, quiero decir. El código permanece impreso durante mucho tiempo, pero los pensamientos y razones de las personas que en un momento particular en una situación particular se llevaron a evaporarse al día siguiente.