Come lavorare con codice scritto male e formattato

Naviga le tue risposte
5

Mi chiedevo come le persone si occupano di lavorare in un progetto con codice mal scritto e formattato, sto parlando di schede e spazi misti, parentesi e righe nuove non necessarie e un sacco di avvertenze che appaiono sul codice dall'IDE. Per il contesto ho questo problema sui progetti java, in cui non è stata concordata alcuna formattazione. Inoltre, nel mio caso sono progetti che non sono ancora stati pubblicati.

Le possibili soluzioni che riesco a vedere sono:

  1. Prova a parlare con il leader del team / proprietario del codice, accetta una formattazione e riformatta tutto in un unico commit. (la mia scelta preferita)
  2. Formatta il pezzo o le parti di codice che devi cambiare, commetti, quindi apporta le modifiche e fai il commit (secondo migliore)
  3. Affrontalo, apporta le modifiche il più minimamente possibile, lasciando tutto il resto come era .. (scelta peggiore, per me)
posta Dale Wijnand 23.05.2012 - 15:19
fonte

3 risposte

7

Sono d'accordo con le tue scelte e il loro ordine. Tieni presente che se si formatta il codice mentre procedete senza una linea guida di codifica concordata, molto probabilmente finirete per giocare a ping-pong in formato di codice con i vostri colleghi che lavorano sugli stessi file.

Inoltre, non aggrapparsi a la tua formattazione particolare: finché c'è una linea guida coerente, il codice sarà leggibile (tutti dovranno adeguarsi per leggere / scrivere il codice in quel formato in modo efficiente, ma questo è il prezzo che devi pagare ed è un investimento "una tantum" in anticipo)

    
risposta data 23.05.2012 - 15:24
fonte
3

Ricorda la Regola dei boy scout , lascia il codice più pulito del modo in cui l'hai trovato.

Pertanto suggerisco di far sì che il team sia d'accordo su una linea guida per la formattazione del codice, quindi di applicare 2. Manterrai alta la produttività e migliorerai il codice man mano che avanzi.

Se hai bisogno di argomenti validi sul perché il codice dovrebbe essere tenuto pulito, ti consiglio di leggere Pulisci codice prenota. Le persone devono essere in grado di leggere e comprendere il codice. Migliore è la formattazione, più velocemente tutti saranno in grado di leggerlo. Anche le macchine (Diff / Merge) fanno molto meglio se il codice è uniformemente formattato.

Se ci sono discussioni su quale sia la formattazione migliore , ricorda che non esiste una cosa del genere. Sono pienamente d'accordo con @Attila qui: come consulente mi sono trasferito da un team all'altro e dopo poche settimane chiunque può abituarsi allo stesso stile di codice. La maggior parte dei "sentimenti" forti sulla formattazione del codice sono nati per abitudine.

    
risposta data 24.05.2012 - 15:15
fonte
2

Uno standard dovrebbe essere impostato di sicuro, altrimenti i membri di ogni team si impegneranno in un progetto con diversi stili di formattazione del codice. Parlerò con il capo squadra di questo argomento prima di parlare del codice di riformattazione.

Se nessuna formattazione continua a essere lo standard per questo progetto, formatta il tuo codice nel modo che ritieni opportuno.

    
risposta data 23.05.2012 - 15:23
fonte

Leggi altre domande sui tag

Il caso dopo caso è efficiente? Qual è il punto di inizializzazione di una variabile con lo stesso valore due volte? [chiuso]