Imagine uma coisa que tornará seu código mais compreensível e também ajudará você a entender o código de outra pessoa com muito mais facilidade, além de "bagunçar" o código de outra pessoa que foi escrito antes de você ingressar na empresa. E o melhor é que você sempre entenderá se vale a pena mudar ou melhor não tocá-lo. Apresentado ?!
O começo é muito promissor e você já sentiu algum tipo de divórcio.
Agora, sério.
Escrevo código para mim mesmo em meu próprio projeto e em uma empresa onde programa mais de um. E comecei a perceber que, mesmo quando trabalho sozinho e volto à seção antiga do código, há pensamentos: "Por que escrevi assim aqui, isso está errado?" E de repente, se eu quiser mudar, pode surgir uma situação que agora está acontecendo algo errado e a decisão que tomei quando escrevi esse código antigo foi ótima.
Por isso, é importante escrever nos comentários “Por que”, “Por que tomei essa decisão quando programei?”, “Por que, dentre todas as opções, escolhi exatamente a implementação em que parei?”. Especialmente se você trabalha em equipe. Tive uma situação em que o código que outra pessoa escreveu não implementava completamente o que eu precisava e agora tenho uma pergunta lógica: "Por que ele fez isso?", Mas não conseguimos lembrar de tudo e logicamente recebemos a resposta: " Não me lembro o porquê. Algo não cresceu juntos lá. " E você se encontra em uma situação de impasse, a opção que agora está disponível e, por outro lado, tem medo de começar a reescrevê-lo, porque você não sabe de onde virá o problema, talvez encontre o mesmo problema insolúvel que seu colega enfrentou ou talvez não . Quem sabe isso agora ?! E isso leva ao fato de que algumas partes do código se tornam "intocáveis", você tem medo de tocá-las.
Portanto, acredito que escrever o motivo da escolha de uma opção gera certos bônus.
- Mesmo quando você trabalha sozinho, você pode entender imediatamente se sabe o motivo.Você ficou bobo quando escreveu esse código ou é um código adequado, dado o contexto.
- Você cresce como programador e pode mudar a decisão que uma vez tomou por inexperiência, porque sabe por que está aqui.
- Com o tempo, a própria razão pela qual esse código é escrito pode "afundar no esquecimento" e, agora, quando você vê isso, entende que pode participar com uma mente tranquila, se não o escrever, ele permanecerá aqui, medo de machucar alguma coisa.
- Você pode ver o código antigo escrito à sua frente de uma nova maneira. Se antes, com um olhar arrogante, você apenas zombava dele, agora entende que na situação que os programadores estavam diante de você, essa era uma decisão muito correta.
- Salva da situação quando você limpa, a decisão da muleta que estava diante de você, e acontece que você abriu a caixa da Pandora, porque somente essa muleta se restringiu à morte universal.
- Quando você escreve o porquê, outro desenvolvedor que vê isso poderá reescrever, sabendo como resolver o problema que você resolveu com mais eficiência.
Em conclusão, eu quero dizer. O código permanece impresso por um longo tempo, mas os pensamentos e as razões das pessoas que em um determinado momento em uma situação específica foram levados a evaporar no dia seguinte.