Ho dovuto implementare un modulo che, una volta completato, il client ha improvvisamente chiesto che per un po 'non fosse necessario visualizzarlo, così mi è stato detto di commentarlo (visto che probabilmente lo useremo in seguito), cosa che ho fatto.
Ora che sto leggendo che commentare il codice è in genere una cattiva idea, quale sarebbe un buon approccio per mettere da parte alcune funzionalità che verranno utilizzate in seguito? È, in questo caso particolare, una cattiva pratica?
Il codice commentato non funziona per almeno due ragioni:
Se ritieni che il ripristino del codice (o non obbligatorio o ripristinato dal controllo del codice sorgente) non costituirà un problema, o in altre parole, se pensi che nulla di quello che viene utilizzato da questo codice cambierà e lo renderà non valido dopo un po ', sarebbe bene semplicemente rimuoverlo per ora, e ripristinarlo quando è necessario di nuovo.
Tuttavia, se sai che il codice verrà utilizzato in futuro e se c'è qualche possibilità che qualcosa cambi in modo che possa influenzarlo, ti suggerirei di utilizzare un approccio simile a Funzionalità della funzionalità , ovvero posizionando il codice sotto un ramo condizionale che verrà eseguito solo quando si "attiva l'interruttore" su on. In questo modo il tuo ambiente di sviluppo continuerà a ricordarti, e chiunque altro, se ci sono delle modifiche che riguardano il codice "nascosto" (ad es. Compilatore, test automatizzati, ecc.). Nel frattempo, hai il sistema in esecuzione in produzione senza la funzione, con la disattivazione.
Leggi altre domande sui tag code-quality comments