Solo un commento
Programmazione R difensiva
Colin Gillespie
Jumping Rivers
Non so te...
- Il codice ovvio oggi
- Spesso è molto meno ovvio tra poche settimane
Commenti
- Puoi aggiungere commenti al codice R con
# - Scrivere buoni commenti è difficile!
# Questo è un commento
# Il commento sopra non è molto utile
# O sì?
Suggerimento 1: evita i commenti ovvi
- A volte è difficile decidere cosa è ovvio
- Per esempio, i commenti
sembrano sensati# Cicla sui dataset for (dataset in datasets) { # Leggi il dataset r <- read.csv(dataset) } - Ma forse sono un po' troppo ovvi
- Per esempio, i commenti
Suggerimento 2: evita commenti che non aggiornerai mai
L’esempio più comune sono i commenti d’intestazione in cima al file
# Ultimo aggiornamento: 1967-02-25
# Autore: D Law
# Stato: No 1
- Questo tipo di commenti quasi mai viene aggiornato
- Una volta ho visto
# list of packages used: XXX, YYY
Suggerimento 3: sii coerente
- Inizia sempre con un singolo
#o doppio## - Inizia con la maiuscola: rispetta la grammatica
- Attento alle battute
- Ciò che a te fa ridere, ad altri può dare fastidio
- Commenta il codice che "sembra sbagliato"
- Usa # TODO o # XXX per indicare un problema futuro
Let's practice
Programmazione R difensiva
