Nel codice di refactoring mi sono imbattuto in codice che conteneva commenti. Guardando più da vicino i commenti, ho potuto vedere che il codice chiaramente non stava facendo quello che dicevano i commenti.
Senza l'accesso al codificatore e alla documentazione , e senza una chiara direzione per quanto riguarda il codice (es. difetti relativi al fatto che il codice funziona in modo errato), è la migliore pratica supporre che il codice sia correggere e pulire i commenti?
È qui che il controllo del codice sorgente è utile. Verifica se il codice ha mai abbinato i commenti. Se ha coinciso, ma è stato modificato in un secondo momento, verifica se il commento sul check-in e altre modifiche apportate nello stesso check-in spiegano adeguatamente il motivo della modifica. In tal caso, aggiorna i commenti del codice.
Se non si riesce a ottenere alcun suggerimento dal controllo del codice sorgente, è necessario assumere che il codice oi commenti potrebbero essere errati. Capire quali sarebbero le conseguenze sulla modifica del codice da abbinare. Se migliora il codice, fallo. In caso contrario, rimuovere o modificare i commenti.
Se non puoi dirlo da solo, il tuo codice non diventa automaticamente la fonte autorevole su come il programma dovrebbe comportarsi, il tuo cliente mantiene sempre quel ruolo. Se entrambi i comportamenti sembrano ugualmente validi per te, chiedi al tuo cliente quale preferiscono. Indica il comportamento esistente, le tue ragioni per sospettare che potrebbe essere necessario cambiarlo e le conseguenze per farlo.
Leggi altre domande sui tag refactoring