Ci sono dei vantaggi nel controllare il codice commentato nel controllo di versione? [duplicare]

8

Ho trovato, quello che personalmente ritengo essere una cattiva abitudine che molti sviluppatori sembrano aver adottato. Il codice in vari punti delle applicazioni che ho visto sono commentati (in gran parte) e controllati nella linea principale. Ora, non ho alcun problema con le persone che fanno questo con le loro proprie filiali, ma è una buona idea commentare circa 60 linee di codice e controllarlo nel bagagliaio? Un collega di miniere ha scoperto molto di questo e ha passato mezza giornata a rimuovere il codice commentato solo per mettere in ordine le cose. C'è qualche vantaggio nel controllare il codice commentato e lasciarlo per un altro sviluppatore che deve riordinare dopo di te? Dopo tutto, il controllo della versione ha una cronologia, quindi puoi facilmente rimuovere qualsiasi codice che è stato rimosso.

    
posta Desolate Planet 02.03.2011 - 01:40
fonte

6 risposte

22

Non vedo alcun beneficio a questo, specialmente nel bagagliaio principale.

Il codice commentato fornisce solo un modo rapido per lo sviluppo di uno sviluppatore. L'intero punto del controllo del codice sorgente è di avere ogni versione funzionante, in modo da poter tenere traccia di ciò che è cambiato.

link - parla di commenti su grossi blocchi e perché sono brutti e difficili da mantenere.

I commenti non vengono verificati e non si evolvono con la base di codice che li circonda. In questo modo, il codice commentato non sarà MAI valido in futuro .... quindi perché tenerlo per tutto quando c'è una versione perfettamente valida che compila solo PRIMA nella lista di commit del trunk principale?

    
risposta data 02.03.2011 - 01:50
fonte
20

C'è una buona ragione, ma probabilmente non si estende spesso a grandi blocchi (60 righe suona eccessivamente - potrebbe invece essere stata usata una piccola nota).

A volte potrebbe essere necessario rimuovere qualche codice utile perché i requisiti delle funzionalità cambiano. Se pensi che il codice possa essere utile in futuro, commentarlo può essere utile per impedire a uno sviluppatore futuro di iniziare da zero, non sapendo che il tuo codice sia mai esistito.

Il controllo della versione ti dà accesso alla cronologia, ma non ti insegna a riguardo. .

    
risposta data 02.03.2011 - 01:50
fonte
5

Ci sono solo due ragioni decenti per fare ciò che posso vedere:

  1. la modifica è destinata a essere temporanea e per rimetterla è necessario un promemoria (ovvero è conservata come segnaposto)

  2. il codice è stato aggiunto a scopo di test che per qualche motivo doveva essere in situ e potrebbe essere necessario di nuovo

risposta data 02.03.2011 - 01:50
fonte
1

Le modifiche possono essere tracciate dai sistemi di controllo della versione come SVN. È facile vedere cosa hai fatto da una versione all'altra. Non è necessario commentare il codice inutilizzato se si desidera effettuare il check-in in SVN.

Penso che commentino il codice principalmente perché potrebbero voler recuperare ciò che è stato modificato o non sono sicuri che la nuova modifica sia corretta.

I commenti sono solo "commenti", con il sistema di controllo della versione, dobbiamo mantenere il codice pulito e in ordine.

    
risposta data 02.03.2011 - 01:54
fonte
1

Con un buon sistema di controllo delle versioni (come git), si può creare rapidamente e facilmente un ramo per contenere codice che altrimenti potrebbe essere commentato e impegnato. Oppure, si potrebbe commettere il codice commentato, quindi rimuoverlo e eseguire nuovamente il commit.

    
risposta data 24.03.2011 - 03:49
fonte
-2

Il codice commentato funge anche da cronologia delle versioni rapida e semplice. Se non vedi i commenti, non sai cosa c'era - indipendentemente dal controllo delle versioni. Tendo a commentare i blocchi mentre sto sviluppando, e li controllo felicemente. Tuttavia, l'avvertenza è che rimuoverò felicemente i blocchi di commento per il codice appena estratto, l'intenzione è che la prossima revisione abbia sempre il commento in lì per il prossimo dev per vedere quando debuggging (presumendo che io abbia commesso un errore, loro possono vedere immediatamente come funzionava quando ha funzionato) ma dopo quella revisione diventa ridondante e può essere rimosso. Ovviamente è necessario applicare un po 'di buon senso a questo, a volte il commento dovrebbe essere lasciato un po' più a lungo, e non si applica a tutti i codici commentati.

    
risposta data 17.01.2012 - 00:21
fonte

Leggi altre domande sui tag