È buona norma utilizzare la formattazione automatica del testo?


11

Sto usando Eclipse e ne parlerò come esempio, ma sono sicuro che questo è il caso in qualsiasi altro IDE.

Eclipse ha il comando CTRL- Shift- Fche formatta automaticamente il tuo codice. È una buona pratica usare questo tipo di formattazione? Sto chiedendo nel contesto di un grande progetto in cui potrebbero esserci molti programmatori che lavorano sugli stessi file e tutti questi sono gestiti da un sistema CSV.

Grazie!

Risposte:


12

Sì.

Eclipse ti consente di definire il tuo stile di codice esportabile che puoi condividere tra tutti i tuoi sviluppatori. Se non vuoi impostare il tuo stile di formattazione, puoi dire ai tuoi sviluppatori di usare la formattazione predefinita di Eclipse. Anche se usi quello predefinito, ti consiglio di esportarlo e metterlo su un'unità di rete condivisa che tutti gli sviluppatori potranno usare. Se più tardi, decidi di cambiare una cosa, sarai in grado di farlo facilmente.

Indipendentemente da ciò, ti consiglierei di iniziare il più presto possibile, il migliore sarebbe all'inizio del progetto e di mantenere il tuo codice sempre formattato nel formato scelto. Dovrai evitare di avere "commit di formato" puri durante lo sviluppo perché è difficile quindi distinguere da commit "reali". In pratica, ciò significa che gli sviluppatori dovrebbero essere rigorosi con i propri impegni .

Inoltre, e lo metto alla fine perché è solo una mia opinione personale, ma considera di rimuovere il limite di 80 caratteri per riga (o estenderlo a qualcosa di più grande, qui abbiamo 120 caratteri) che è, se non sbaglio il lunghezza di riga di formattazione automatica predefinita su Eclipse. Ora abbiamo tutti schermi grandi e risoluzioni per schermi grandi, quindi va bene. A tale proposito, controlla se il limite di 80 caratteri è ancora rilevante in tempi di domande e risposte su monitor widescreen , potresti quindi essere in grado di prendere la tua decisione.

Modifica: Thorbjørn sottolinea la funzionalità "Formatta ogni volta che un file viene salvato".


5

Sì, è un'ottima pratica. Assicura che tutti sono d'accordo come file di origine dovrebbero guardare quando viene aperto in un editor.

Inoltre, ho avuto ottime esperienze con la funzionalità "Formatta ogni volta che un file viene salvato". (Utilizziamo la configurazione standard del formatter di Eclipse).

Abilitalo aprendo le proprietà Eclipse e selezionare Java -> Editor -> Salva azioni. Abilita "Esegui le azioni selezionate al salvataggio" e "Formatta codice sorgente".

Il motivo è naturalmente che il codice è sempre formattato, quindi puoi formattarlo a piacimento durante la modifica senza temere che si rompano. Ciò garantisce anche che i log del repository di origine siano accurati (il che è importante quando si esegue l'analisi forense).


Dimenticato, buon punto.
Jalayn,

3

Dovresti avere uno standard di codifica che tutti seguirai. Se questo è imposto da strumenti esterni (come il rientro), o IDE, o manualmente è un po 'irrilevante. Ciò che è rilevante è che dovrebbe essere fatto qualsiasi prima del commit.


3

È buona norma seguire uno standard di codifica ben definito in un progetto / azienda. I mezzi per farlo possono variare, basta scegliere quello che funziona meglio per la tua organizzazione. Se tutti usano Eclipse, allora potresti semplicemente creare un formato di codice esportabile per i tuoi progetti e diffonderlo tra gli sviluppatori (Eclipse ha anche un'opzione per formattare i file automaticamente ad ogni salvataggio), tuttavia consiglierei di creare un documento che descriva il formato scelto.

Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.