Consigli generali su come scrivere buon codice
Scegliere nomi di funzione efficaci è una parte essenziale della scrittura di buon codice. Tieni presente le seguenti raccomandazioni quando dai un nome a una funzione.
Quando dai un nome a una funzione, devi avere chiaro cosa fa.
Per esempio, la funzione get(studentId, subject) non ha un nome significativo: non è chiaro cosa faccia.
Potrebbe ottenere il voto di uno studente in una materia oppure il suo stato di iscrizione.
Un nome migliore sarebbe getStudentGrade(studentId, subject), perché comunica con precisione cosa fa la funzione.
Fai attenzione a non rendere il nome di una funzione troppo lungo.
Per esempio, checkStudentFailOrPassOrMeritOrDistinction(mark) è un nome di funzione inutilmente lungo.
Più il nome è lungo, più è difficile ricordarlo e più spazio occupa sullo schermo del computer.
Al contrario, un nome di funzione troppo corto può confondere chi legge.
Per esempio, checkFPMD(mark) è un brutto nome di funzione: non è immediatamente chiaro cosa significhi «FPMD».
Il nome di una funzione dovrebbe essere comprensibile a chiunque legga il codice.
Per esempio, un nome di funzione oscuro come DeathStar() può sembrarti divertente, ma non comunica il suo scopo e può confondere gli altri sviluppatori che leggono il codice.
Attieniti a un'unica convenzione per dare un nome alle operazioni che fanno la stessa cosa.
Per esempio, se la funzione che recupera il nome di uno studente si chiama getStudentName(), non dovresti usare un verbo diverso nel nome della funzione per ottenere il voto di uno studente (ad esempio retrieveStudentGrade()).
Per esempio, non continuare a usare add quando vuoi inserire un gruppo di elementi in una collezione, se lo hai già usato per l'addizione di due numeri.
Usa invece insert o append.