Ciao a tutti nella community di CodeGym! Oggi parleremo della qualità del codice. Sì, cari amici. Nessuno è perfetto. Tutti a un certo punto si rendono conto che il codice potrebbe essere migliore... Ma cosa fare in questa situazione? Come minimo, inizia a ricercare questo problema. Ma sei già qui, il che significa che l'argomento deve interessarti, quindi andiamo. Oggi descriveremo i modi in cui puoi rendere il tuo codice migliore e più pulito. Quindi non ti vergognerai del tuo codice attuale in futuro! :) Tutti questi metodi aiuteranno un programmatore a diventare un buon programmatore.
1. Se vuoi migliorare il tuo codice, leggi quello di qualcun altro
Se vuoi migliorare notevolmente le tue capacità di programmazione, devi... leggere il codice scritto da altri programmatori. Credimi o no. Ma se corri il rischio, te lo prometto: sarai ricompensato per il tempo speso. Ad esempio, non leggere su medium.com come funzionano HashMap, ArrayList, LinkedList, ecc. Invece, leggi il loro codice sorgente e scoprilo tu stesso. Ecco un elenco di classi da leggere:
Le domande più frequenti nelle interviste riguardano HashMap. Puoi prendere due piccioni con una fava: capirai il codice e acquisirai le conoscenze di cui hai bisogno.
La stessa cosa vale per ArrayList. Non c'è niente di complicato, ma vale davvero la pena leggere e comprendere il codice sorgente.
String è un ottimo esempio. Comprendi perché è immutabile.
AtomicInteger è una classe interessante: definisce operazioni atomiche su oggetti interi.
Dopodiché, potremmo elencare ogni classe, una dopo l'altra :)
Più seriamente, dovresti leggere il codice di Pivotal. Le persone lì hanno scritto l'ecosistema più richiesto nel mondo Java. Vale sicuramente la pena leggere il loro codice. Ti consiglio di iniziare con Spring Core . Leggere codice sorgente sconosciuto è un lavoro difficile ma gratificante. :)
2. Seguire le convenzioni del codice
Le convenzioni di codifica sono un insieme di linee guida create dai team di sviluppo. Includono linee guida per lo stile e le tecniche di codifica per ogni aspetto del codice. Queste convenzioni possono essere scritte per l'intera azienda o per un progetto specifico. Le convenzioni di codifica sono generalmente specifiche per ogni linguaggio di programmazione e coprono l'organizzazione dei file, i rientri, i commenti, le dichiarazioni, gli operatori, gli spazi, le convenzioni di denominazione, le tecniche e i principi di programmazione, le regole di programmazione, le migliori pratiche per l'architettura e così via. Il vantaggio principale di alcuni standard è il fatto che il codice ha lo stesso aspetto ed è scritto nello stesso stile. Ciò lo rende più leggibile e aiuta i programmatori a comprendere il codice scritto da un altro programmatore. Se gli standard di codifica vengono seguiti e applicati in modo coerente durante tutto il processo di sviluppo, in futuro sarà più facile mantenere ed estendere il codice, rifattorizzarlo e risolvere i conflitti di integrazione. Le convenzioni di codifica sono importanti per i programmatori per una serie di motivi:
Il 40-80% del costo del software va alla sua manutenzione,
Quasi nessun software viene mantenuto dal suo autore per tutta la sua vita,
Le convenzioni di codifica migliorano la leggibilità del codice sorgente consentendo ai programmatori di comprendere il nuovo codice più rapidamente.
Ad essere onesti, sono un grande fan degli standard di codifica. Per me ha senso passare il tempo a discuterne e discuterne, poiché è un'attività preziosa che ti farà risparmiare tempo e fatica in futuro. Le convenzioni del codice dovrebbero essere riviste frequentemente. Le regole possono essere modificate da "obbligatorio" a "facoltativo" e viceversa. Se alcuni di essi non funzionano come previsto, dovrebbero essere rivisti o rimossi dalle linee guida.
3. Usa le revisioni del codice
Una revisione del codice è uno degli strumenti più potenti per il miglioramento del codice. Perché? Perché il codice verrà esaminato da quegli esperti che non l'hanno scritto. E un nuovo look è molto utile. E una revisione del codice è spesso ciò che aiuta a prevenire la scrittura di un codice decisamente terribile. So che le revisioni del codice non sono sempre possibili, perché devi trovare un'altra persona disposta a farne una. Ma ciò non significa che dovresti saltare l'uso di questo strumento. Al contrario: le revisioni del codice sono un motivo per trovare persone affini che hanno anche bisogno di migliorare la qualità del loro codice. A proposito, chi ti impedirà di trovarli qui su CodeGym? In un posto dove tutti vogliono essere programmatori.
4. Scrivere unit test
La mia tecnica preferita per migliorare il codice è sicuramente scrivere unit test. Più ne scrivi, meglio è. Nella programmazione per computer, il test unitario è un processo di sviluppo software in cui il più piccolo pezzo di codice sorgente testabile, chiamato unità, viene testato individualmente e indipendentemente per vedere se funziona come previsto. Questo ti aiuterà a scoprire errori nei tuoi algoritmi e/o nella logica prima di rilasciare il tuo codice. Poiché il test unitario richiede che il codice sia strutturato in modo appropriato, il codice deve essere suddiviso in funzioni più piccole e più mirate. Ciascuno è responsabile di una singola operazione su un set di dati, piuttosto che di funzioni di grandi dimensioni che eseguono diverse operazioni (il principio di responsabilità singolasaluta...). Il secondo vantaggio di scrivere codice ben collaudato è che puoi evitare di violare il codice quando apporti piccole modifiche alle funzionalità esistenti. Quando i test unitari falliscono, ti diranno che qualcosa è stato scritto in modo errato. A prima vista, il tempo di sviluppo impiegato per scrivere unit test sembra un costo aggiuntivo. Tuttavia, i test unitari faranno risparmiare tempo sul debug in futuro. Questo dovrebbe essere un processo graduale. Quindi andiamo avanti con un sorriso: scriveremo test per ogni metodo e classe :D
5. Utilizzare gli strumenti per migliorare la qualità del codice
Non c'è sviluppatore che non abbia mai commesso un errore. In genere, il compilatore rileva i problemi di sintassi e aritmetica e visualizza l'analisi dello stack. Ma potrebbero ancora emergere alcuni problemi che il compilatore non rileva. Ad esempio, requisiti implementati in modo errato, algoritmi errati, codice strutturato in modo errato o qualche altro potenziale problema che la comunità conosce per esperienza. L'unico modo per rilevare errori come questo è chiedere a uno sviluppatore più anziano di rivedere il tuo codice, giusto? Ma questo approccio non è una panacea e non cambierà molto. Per ogni nuovo sviluppatore del team, dovresti avere un paio di occhi in più per guardare il suo codice. Fortunatamente, ci sono molti strumenti là fuori che possono aiutarti a controllare la qualità del tuo codice. Ho usato Checkstyle, PMD, FindBugs e SonarQube nel mio lavoro su vari progetti. E ce ne sono anche altri. Sono tutti tipicamente utilizzati per analizzare la qualità del codice e generare alcuni report utili. Molto spesso questi report vengono pubblicati da server di integrazione continua come Jenkins.
6. Scrivi un codice semplice e diretto
Scrivi sempre codice semplice, comprensibile e logico. Le persone tendono a scrivere codice complicato per dimostrare di poterlo fare. Il codice semplice e logico funziona sempre bene, porta a meno problemi ed è più estensibile. Un buon codice è la migliore documentazione. Se pensi di aggiungere un commento, chiediti: "Come posso migliorare il codice in modo che questo commento non sia necessario?" —Steve McConnell.
7. Leggere la documentazione
Una delle abitudini più importanti dei buoni programmatori è leggere molta documentazione. Che si tratti di specifiche, JSR, documenti API, tutorial o qualcos'altro, la lettura della documentazione ti aiuta a costruire una solida base per la tua migliore programmazione. Ultimo ma non meno importante, non confrontarti con gli altri. Confrontarsi con gli altri porterà solo a sentimenti negativi e competizione malsana. Ogni persona ha i suoi punti di forza e di debolezza. Ciò significa che è importante conoscerli e lavorare con loro. Fai un inventario di te stesso: elenca i tuoi punti di forza e lavora su di essi. Programmare è un vero piacere: divertiti.
"La costante di un uomo è la variabile di un altro uomo."
8. Segui blogger interessanti
Migliaia di appassionati in tutto il mondo lavorano e scrivono sulle stesse tecnologie. I blog sono spesso scritti dagli stessi programmatori e la maggior parte di essi condivide opinioni ed esperienze personali. Attraverso i blog, puoi vedere diverse prospettive sulla stessa tecnologia. Puoi vedere sia tecnologie buone che cattive sui blog. Come minimo, leggi articoli sul blog Coding Dojo e CodeGym :) Segui buoni blog e commenta i post, condividi la tua opinione.
9. Leggi libri sulla professione
Niente può sostituire un buon libro. Un buon libro insegna i concetti di base in una forma molto più semplice e si applica alle cose nel mondo reale. I loro autori sono essi stessi grandi programmatori. Leggendo libri, puoi imparare dall'esperienza di qualcun altro. Ti suggerisco di leggere "Effective Java" di Joshua Bloch. Questo libro presenta settantotto regole empiriche indispensabili per i programmatori: le migliori soluzioni di lavoro per i problemi di programmazione che affronti ogni giorno. Contiene le linee guida più pratiche e autorevoli per scrivere programmi efficaci e ben progettati. Se hai appena iniziato con Java e non hai esperienza di programmazione, puoi leggere "Sams Teach Yourself Java 2 in 24 Hours". E per scrivere codice pulito, c'è un libro eccellente, "Clean Code", di Robert Martin. Dopo averlo letto,
10. Codice! Codice! Codice!
Non puoi diventare un buon programmatore solo imparando a memoria un libro. È facile parlare di concetti teorici. Ma puoi solo imparare i limiti di una lingua o elaborare le migliori pratiche quando scrivi il codice. Pertanto, per diventare un buon programmatore, devi scrivere molto codice. Se sei un principiante, inizia scrivendo programmi per compiti semplici come la serie di Fibonacci, i palindromi, il triangolo di Pascal, ecc. Quindi passa a compiti più grandi come un albero di ricerca binario, ecc. Se stai cercando una piattaforma online per esercitarti con Java programmi, dai un'occhiata a Coding Ground . Fatti strada attraverso i corsi di programmazione e ti garantisco che le tue abilità saranno molto migliori. Un'altra opzione è seguire il corso Harvard CS50, che è gratuito.
Riassumiamo
La persona che non commette errori è quella che non fa nulla. Ecco perché esercitiamo la nostra pazienza e, come una cavalletta laboriosa, affiniamo le nostre capacità di programmazione. Per fare questo, non dimenticare:
Oggi parleremo della qualità del codice. Sì, cari amici. Nessuno è perfetto. Tutti a un certo punto si rendono conto che il codice potrebbe essere migliore... Ma cosa fare in questa situazione? Come minimo, inizia a ricercare questo problema. Ma sei già qui, il che significa che l'argomento deve interessarti, quindi andiamo. Oggi descriveremo i modi in cui puoi rendere il tuo codice migliore e più pulito. Quindi non ti vergognerai del tuo codice attuale in futuro! :) Tutti questi metodi aiuteranno un programmatore a diventare un buon programmatore.
Le convenzioni di codifica sono un insieme di linee guida create dai team di sviluppo. Includono linee guida per lo stile e le tecniche di codifica per ogni aspetto del codice. Queste convenzioni possono essere scritte per l'intera azienda o per un progetto specifico. Le convenzioni di codifica sono generalmente specifiche per ogni linguaggio di programmazione e coprono l'organizzazione dei file, i rientri, i commenti, le dichiarazioni, gli operatori, gli spazi, le convenzioni di denominazione, le tecniche e i principi di programmazione, le regole di programmazione, le migliori pratiche per l'architettura e così via. Il vantaggio principale di alcuni standard è il fatto che il codice ha lo stesso aspetto ed è scritto nello stesso stile. Ciò lo rende più leggibile e aiuta i programmatori a comprendere il codice scritto da un altro programmatore. Se gli standard di codifica vengono seguiti e applicati in modo coerente durante tutto il processo di sviluppo, in futuro sarà più facile mantenere ed estendere il codice, rifattorizzarlo e risolvere i conflitti di integrazione. Le convenzioni di codifica sono importanti per i programmatori per una serie di motivi:
Perché? Perché il codice verrà esaminato da quegli esperti che non l'hanno scritto. E un nuovo look è molto utile. E una revisione del codice è spesso ciò che aiuta a prevenire la scrittura di un codice decisamente terribile. So che le revisioni del codice non sono sempre possibili, perché devi trovare un'altra persona disposta a farne una. Ma ciò non significa che dovresti saltare l'uso di questo strumento. Al contrario: le revisioni del codice sono un motivo per trovare persone affini che hanno anche bisogno di migliorare la qualità del loro codice. A proposito, chi ti impedirà di trovarli qui su CodeGym? In un posto dove tutti vogliono essere programmatori.
Scrivi sempre codice semplice, comprensibile e logico. Le persone tendono a scrivere codice complicato per dimostrare di poterlo fare. Il codice semplice e logico funziona sempre bene, porta a meno problemi ed è più estensibile. Un buon codice è la migliore documentazione. Se pensi di aggiungere un commento, chiediti: "Come posso migliorare il codice in modo che questo commento non sia necessario?" —Steve McConnell.
Una delle abitudini più importanti dei buoni programmatori è leggere molta documentazione. Che si tratti di specifiche, JSR, documenti API, tutorial o qualcos'altro, la lettura della documentazione ti aiuta a costruire una solida base per la tua migliore programmazione. Ultimo ma non meno importante, non confrontarti con gli altri. Confrontarsi con gli altri porterà solo a sentimenti negativi e competizione malsana. Ogni persona ha i suoi punti di forza e di debolezza. Ciò significa che è importante conoscerli e lavorare con loro. Fai un inventario di te stesso: elenca i tuoi punti di forza e lavora su di essi. Programmare è un vero piacere: divertiti.
GO TO FULL VERSION