Mod righe in codice Java

1

Spesso nel codice C (e anche in altri linguaggi) ho visto una sezione nei commenti di primo livello per le linee mod. Questi includono la data in cui è stata apportata una modifica al file, l'utente che ha apportato la modifica e una breve descrizione di ciò che è stato modificato.

Non ho ancora visto un equivalente di questo in Java. Penso che questa informazione sia utile, specialmente quando cerco di rintracciare bug nel codice che non ho scritto. È perché il codice Java è spesso sotto controllo di versione, o ci sono altri motivi? Ci sono suggerimenti su come includere le informazioni nel file di codice?

    
posta Michael K 01.11.2010 - 16:04
fonte

3 risposte

10

Non vedo alcun motivo per avere quei commenti inutili in qualsiasi file sorgente. Sta semplicemente reinventando il controllo della versione estremamente male.

    
risposta data 01.11.2010 - 16:10
fonte
1

Ho visto spesso file Java con un'intestazione che include la data originale creata e l'autore, ma non "linee mod". Il controllo della versione lo renderebbe piuttosto superfluo, in quanto tiene traccia delle modifiche per riga per utente.

Per quanto riguarda il motivo per cui vengono utilizzati in C, forse è una vecchia abitudine di prima dei giorni di VC.

    
risposta data 01.11.2010 - 16:12
fonte
0

Spesso in Java vedo questi tipi di linee, ma non è inserito manualmente. La maggior parte dei VCS può taggare qualsiasi file di testo con quei dati, purché nel file sia lasciato un modello per inserire tali informazioni.

Ad esempio, nel VCS che uso, se includo $Id: ... $ in qualsiasi punto del file, ... verrà sostituito con il nome del file, il numero di versione, l'ultimo editor, la data di modifica, ecc.

Alcune persone pensano di essere inutili alla luce dei VCS (che memorizzano tutte queste informazioni), ma io no. È un rapido accesso a quelle informazioni che dovresti estrarre (o almeno lasciare il tuo editor di file) passando attraverso VCS.

Modifica : a proposito, nessuno ha evidenziato il motivo principale per cui non li ho graditi (ricordo, ho detto che non sono inutili, non che mi piacciono). Odio che aggiungano modifiche testuali al file ad ogni check-in. O hai bisogno di un client diff altamente configurabile per ignorare tali modifiche, o ti troverai di fronte a cambiamenti di stereotipo in ogni revisione che rendono più complicato vedere cosa è effettivamente cambiato.

    
risposta data 01.11.2010 - 16:11
fonte

Leggi altre domande sui tag