Contesto
A distanza di più di un anno ho scoperto di aver aperto una pull request con commenti in italiano. La PR era stata approvata ma non è stata ancora mergiata nonostante i solleciti di vari utenti.
Ecco la PR in questione: https://lnkd.in/d-YHk5f4
Lingua dei commenti
La richiesta di scrivere i commenti in inglese è comune in molti contesti, ma non sempre condivisibile. Spesso si trovano commenti in inglese di scarsa qualità grammaticale che risultano quasi incomprensibili. In contesti che hanno scarso carattere internazionale, l’obbligo dell’inglese può risultare più dannoso che utile.
Mancanza di commenti
Un altro fenomeno è che molti sviluppatori non scrivono commenti, forse per timore di rendere il lavoro di chi dovrà mergiare la PR troppo semplice. Tuttavia, la mancanza di commenti complica la comprensione della logica delle modifiche e può essere percepita come una mancanza di rispetto verso chi dovrà approvare o mantenere il codice in seguito.
Buone pratiche
- Scrivere commenti chiari e utili che spiegano il perché di una scelta, non solo cosa fa il codice.
- Se il progetto è internazionale, preferire l’inglese ma curarne la qualità grammaticale.
- Nei progetti locali o interni, usare la lingua più pratica per il team (italiano o inglese), privilegiando la chiarezza.
- Non evitare i commenti per timore: adeguati commenti facilitano le revisioni e la manutenzione.
Conclusione
I commenti nel codice restano uno strumento fondamentale per la collaborazione e la manutenzione. La scelta della lingua dovrebbe seguire le esigenze del progetto e la qualità dei commenti deve essere sempre curata.
Per informazioni o per un confronto tecnico: Visita il sito