Ciao gente, questo articolo non riguarda alcune funzionalità o concetti relativi a Java, ma molto di più. Fondamentalmente, spiegherò tutti gli errori che uno sviluppatore java fa durante la scrittura del codice e quindi come puoi minimizzarlo e non devi rifattorizzare il tuo codice. Quindi questo articolo riguarda le BEST PRACTICE che uno sviluppatore dovrebbe sempre seguire.

1. Cosa c'è nel nome:

Uno sviluppatore dovrebbe sempre cercare di dare un nome significativo alle variabili, ai metodi e alle classi. Diventa troppo facile capire di cosa tratta il metodo, la classe o la variabile quando qualcuno legge il tuo codice durante la revisione o il debug. Assegnare nomi come a, b e c alla variabile non significa alcun significato e diventa meno rilevante durante il debug del codice.

1. Iniziare sempre il nome di una classe con lettere maiuscole. Per esempio.

public class Employee {
}

2. Iniziare sempre il nome di una variabile con lettere minuscole. Per esempio.

private int salary;

3. Iniziare sempre il nome del metodo con lettere minuscole e non includere le parole And e Or nel nome del metodo. Per esempio.

public int calculateSalary(int noOfDaysWorked , int baseSalary)

public final int RETIREMENT_AGE = 58;

2. Più piccoli i metodi migliori per gestire ed eseguire il debug:

Scrivere molte cose in una singola funzione porta a una cattiva implementazione del progetto. Inoltre, non è consigliabile scrivere metodi troppo grandi poiché è difficile eseguire il debug se vengono eseguite così tante cose in una singola funzione. Quindi scrivi la tua funzione tra 10 e 15 righe concentrandoti su una singola cosa che fa il metodo.

3. Sii intelligente per ridurre le righe di codice:

Cerca sempre di pensare prima ancora di iniziare a scrivere qualsiasi pezzo di codice. Inoltre, pensa se esiste la possibilità di ridurre il numero di righe che desideri scrivere. In genere, gli sviluppatori controllano una condizione booleana nel blocco if e quindi restituiscono il valore. Questo non è il modo corretto di scrivere il codice. Lasciatemi spiegare il pezzo di codice per una migliore comprensione.

boolean isContractor(Employee employee) { 
     if(employee.isCtr) { 
        return true;
     } else {
        return false;
     }
}

boolean isContractor(Employee employee) {
       return employee.isCtr;
}

4. Sono necessari commenti?

Sì, i commenti aggiungono significato a metodi o algoritmi complessi ma non sono necessari per il tuo codice. Se scrivi un pezzo di codice e pensi che qualsiasi sviluppatore possa capire semplicemente leggendo il codice, non è necessario aggiungere commenti al codice autoesplicativo. Ma ricorda di aggiungere commenti in cui pensi di aver spiegato o scritto una logica o un algoritmo complesso in modo che in seguito qualsiasi sviluppatore possa capire durante il debug del codice.

5. Singolo compito in un metodo:

L'aggiunta di molte attività/cose in un unico metodo non è un buon progetto. Quindi gli sviluppatori dovrebbero sempre cercare di mantenere funzioni diverse per le diverse attività da eseguire. Per esempio.

public void addUser(String userName , String password) {
//perform user addition operation to DB
}

Scrivi sempre le funzioni nell'ordine in cui vengono chiamate. Inoltre, scrivi tutte le variabili all'inizio di tutti i metodi, così diventa più facile da individuare. Se alcune variabili vengono utilizzate solo in una singola funzione, prova a rendere tali variabili variabili locali per quella funzione.

7. Ai revisori non piace il codice duplicato:

Ogni volta che inizi a scrivere codice, puoi dare un'occhiata alle funzioni e alle classi correlate nella base di codice per verificare se funzionalità simili esistono già o meno. Se esiste un metodo che esegue la stessa attività che desideri, riutilizzalo.

Se c'è un metodo che ha un codice simile a quello che vuoi scrivere, scrivi una singola funzione che eseguirà il compito di entrambe le funzioni, una che è già presente nella base di codice e l'altra che volevi scrivere. Questa è la migliore pratica per rimuovere il codice duplicato.

8. Controlla la funzionalità del tuo codice scrivendo Casi di test:

Una volta che hai finito di scrivere i tuoi metodi e le classi correlate, vai avanti e identifica gli scenari di test e i casi limite per la funzionalità del tuo codice.

Ora puoi includere casi di test per tutti questi scenari identificati e verificare se il tuo codice supera o meno questi casi di test. Durante la codifica, se ti sei perso alcuni casi d'angolo, prova a includerli.

9. Non codificare:

L'hard coding è una cattiva idea che generalmente vedo fare a molti sviluppatori durante la codifica. Se stai codificando alcune stringhe, diventa difficile testare la funzionalità implementata da te. Potrebbe introdurre bug nel tuo codice se qualcosa viene modificato in relazione al tuo codice.

private static String serverIpAddress = "1.2.3.4";

10. La registrazione semplifica il debug del codice:

Durante la scrittura del codice, ogni sviluppatore dovrebbe provare a registrare i punti necessari sulla funzionalità per avere un'idea del flusso o informazioni importanti. Rende più facile per un altro sviluppatore leggere i log e controllare il flusso del codice, eseguire il debug e risolvere il problema.

Il codice senza registri o registri impropri non aiuta gli altri sviluppatori a comprendere facilmente il codice e lo sviluppatore stesso deve impegnarsi ulteriormente per eseguire il debug del problema.

Inoltre, tieni presente che lo sviluppatore non deve registrare tutti i risultati delle istruzioni poiché una registrazione eccessiva potrebbe ridurre le prestazioni dell'applicazione.

11. Ridurre i parametri del metodo:

Passare molti parametri a una singola funzione non è una buona pratica. Invece, dovresti provare a creare un oggetto e quindi passare quell'oggetto come parametro per funzionare. Ciò migliora la leggibilità del codice e quindi migliora la qualità del codice.

Per esempio.

public void addUser(String name , String gender , 
    String age ,String userName , String password) {
    //perform user addition operation to DB
}

public void addUser(User user) {
    //perform user addition operation to DB
}

//where user will be a class 
class User{
    private String name ;
    private String gender ;
    private int age ;
    private String userName;
    private String password;
    //here we can have constructors and getters and setters 
    //for above instance variables 
}

12. Riutilizzo del codice:

Ho già parlato di codice duplicato che dovresti evitare. Fondamentalmente, dovresti sempre cercare le tue funzionalità prima di scriverle nella base di codice o nell'area del codice correlata e se le trovi usale, e in caso contrario vai avanti con il tuo metodo e scrivile.

13. FINE NOTA

Ho scritto molte best practice che ogni sviluppatore dovrebbe seguire durante la scrittura del codice in qualsiasi lingua. Queste best practice migliorano le tue capacità di scrittura del codice e ti aiuteranno sicuramente nel prossimo futuro. Spero che tu abbia preso nota di questi punti importanti e che li implementerai nelle tue pratiche di scrittura del codice.

È possibile utilizzare il plug-in SonarLint per Eclipse e IntelliJ IDE per migliorare la qualità del codice. Questo plug-in suggerisce quali sono le migliori pratiche durante la scrittura del codice.

In conclusione, la scrittura di codice pulito è un aspetto essenziale dello sviluppo del software che può avere un impatto significativo sulla qualità, sulla manutenibilità e sul successo complessivo di un progetto. Il codice pulito è caratterizzato dalla sua leggibilità, semplicità e chiarezza e segue le convenzioni di codifica stabilite e le migliori pratiche.

L'obiettivo finale della scrittura di codice pulito è rendere più facile per gli altri (e per le versioni future di te stesso) la comprensione e il lavoro, portando a una maggiore efficienza e alla riduzione dei bug. Aderire ai principi del codice pulito richiede disciplina e uno sforzo costante per migliorare, ma i vantaggi valgono l'investimento.

Segui Vikram Gupta per contenuti simili.