Devo commentare o rimuovere qualsiasi codice non usato dalla mia soluzione?

Se apprezzi le pratiche di lavoro pulite, suggerirei che invece di commentare il codice (che è una pratica abbastanza buona a brevissimo termine, cioè quando parliamo un paio di settimane o meno), preferisco usare una fonte sistema di controllo (Git, Mercurial, Subversion, ecc.):

Sposta il codice della funzione e tutto ciò che è specificamente correlato ad esso e non utilizzato da altro codice, in un ramo di funzione separato (cioè un fork fuori dal tuo attuale ramo di sviluppo). Assicurarsi che il codice sia stato completamente rimosso nel ramo di sviluppo principale. In questo modo, tutto ciò che dovrai fare per riattivare la funzione è quello di unire nuovamente il ramo delle funzionalità nel ramo di sviluppo principale. Quello che non devi fare è annullare il commento su base riga per riga (con la possibilità che tu dimentichi di decommentare qualcosa, da qualche parte).

Potrebbe essere un po 'più di lavoro, ma una pratica di lavoro molto più pulita rispetto al commentare il codice. Il codice commentato ha l'abitudine di accumularsi nel tempo, e spesso non viene mai più scomposto (contro le aspettative precedenti). Per questo motivo, a meno che un pezzo di codice commentato non abbia una documentazione esplicita che spiega perché è commentato, e quando dovrebbe essere nuovamente non commentato, tendo a eliminare il codice commentato da un codice base ogni volta che ci inciampo.

Per lo stesso motivo, ti suggerirei di non disabilitare / rimuovere il codice di "attivazione" di una funzione, ma tutti gli altri codici che sono anche relativi alla sola (anche se non avrebbe mai alcun effetto se hai rimosso il codice funzione principale). Perché, se alla fine non inserisci la funzione nella prossima versione, potresti dimenticarti del codice dipendente. Quindi trattalo come il codice "core" / triggering.

Ecco cosa farei:

• Prima di fare qualsiasi cosa, ci assicuriamo che il tuo codice sia archiviato in controllo della fonte. In questo modo, puoi sempre recuperarlo in seguito, se necessario a.

• La regola generale è che devi rimuovere il codice che non ti serve più, per mantenere il codice base più pulito possibile. Quindi, se non lo fai aspettati che il tuo codice venga riutilizzato nel "prossimo futuro", rimuovilo.

• Tuttavia, in questo caso, ci sono buone ragioni per aspettarsi che il tuo codice sia usato nella prossima versione. Quindi, commentarlo ( con un commento per spiegare cosa stai facendo ) è probabilmente la soluzione migliore. Se scopri che non lo utilizzi dopo tutto, tu (o il tuo successore) puoi rimuoverlo in seguito.

In alternativa, se il tuo codice è autonomo e questa misura è temporanea, puoi farla franca avvolgendo il codice all'interno di un'istruzione if e impostando un flag booleano per disabilitare il blocco di codice. Comunque sia, questa è una buona pratica ...

Se usi il controllo di versione come SVN, Git o Mercurial puoi metterlo su un altro ramo e rimuoverlo dal rilascio / ramo principale. Puoi unire il ramo al ramo di rilascio quando è pronto per il rilascio.

Se non usi il controllo di versione, va bene inserirlo nei commenti. Tuttavia, quando metti qualcosa nei commenti è facile dimenticarlo, quindi ti consiglio di iniziare a utilizzare il controllo di versione se non lo fai già.