HOWTO · R

Commenta le multilinee in R

In questo articolo imparerai come commentare le multilinee in R senza dover scrivere manualmente un carattere # all'inizio di ciascuna delle righe da commentare.

In questa pagina

R non dispone di una sintassi per i commenti su più righe: # avvia un commento che prosegue fino alla fine della riga. Per disattivare temporaneamente più righe, inserisci # all’inizio di ciascuna. Per ripristinare il codice, rimuovi questi prefissi. Gli editor possono farlo automaticamente sulle righe selezionate.

Esegui questo esempio:

Il codice e le etichette o gli output visibili in questa sezione restano in inglese.

# This line is a comment.
total <- 2 + 3
print(total)
[1] 5

La prima riga viene ignorata come codice R; l’assegnazione e la chiamata a print() restano eseguibili. L’esecuzione fornita è terminata correttamente e ha stampato [1] 5.

Come funzionano i commenti in R

Il simbolo di commento si applica solo al resto della riga corrente. Per esempio, in answer <- 42 # keep this value, R esegue l’assegnazione e ignora il testo dopo #. Anche una riga che inizia con # può documentare il codice senza modificarne il comportamento. Poiché ogni commento termina con un a capo, un gruppo di righe commentate è comunque composto da commenti distinti, uno per riga, e non da un unico commento a blocco.

Per commentare del codice, aggiungi il prefisso a ogni riga selezionata, comprese quelle di continuazione. Se anche una sola riga eseguibile resta senza commento, R la eseguirà quando viene caricato lo script. Per rimuovere i commenti, fai l’operazione inversa: elimina il prefisso da tutte le righe che vuoi eseguire di nuovo.

Commentare un blocco di codice nell’editor

In RStudio, seleziona le righe e premi Ctrl+Shift+C su Windows oppure Command+Shift+C su macOS. Lo stesso comando attiva o disattiva i commenti nella selezione, quindi controlla il risultato prima di eseguirlo. Per i dettagli, consulta le scorciatoie da tastiera di RStudio.

In Notepad++ su Windows, Ctrl+Q attiva o disattiva il commento delle righe selezionate. In Emacs, esegui M-x comment-region; per annullare, esegui M-x uncomment-region. Le scorciatoie variano in base all’editor, al sistema operativo, alla mappa dei tasti e alla selezione; se una combinazione non funziona, consulta l’elenco dei comandi dell’editor. Questi comandi aggiungono o rimuovono prefissi di commento dalle righe: non introducono una nuova sintassi per i commenti in R.

Perché scan() non crea un commento su più righe

scan() legge valori da una connessione o da un input e li restituisce a R. Non inserisce testo nel file sorgente e non trasforma le righe digitate in commenti. Allo stesso modo, rm() rimuove un oggetto R dall’ambiente di lavoro, ma non cancella il testo del sorgente. Digitare testo libero nella console di R non è un modo valido per commentare uno script, perché R prova a interpretare ogni riga inviata come input. Usa invece il comando per i commenti dell’editor oppure aggiungi # a ogni riga del sorgente.

Trasformare il testo degli appunti in commenti # con una funzione R

Se l’editor non offre un comando pratico per le righe selezionate, puoi usare la funzione facoltativa FormatComment, che antepone # e alcuni spazi alle righe copiate negli appunti. Le chiamate readClipboard() e writeClipboard() funzionano solo su Windows. Definisci la funzione in una sessione R su Windows, copia testo semplice o codice e poi chiamala; controlla il risultato prima di sostituire del testo nello script. La funzione riscrive gli appunti con il testo formattato: se vuoi conservare il contenuto originale, incollalo prima in una posizione sicura.

Il codice e le etichette o gli output visibili in questa sezione restano in inglese.

FormatComment <- function() {
  lines <- readClipboard()
  commented <- paste0("#   ", lines)
  writeClipboard(commented, format = 1)
  invisible(commented)
}

Il caso fornito per la funzione è terminato correttamente senza segnalare output. Questo risultato non dimostra il comportamento con gli appunti reali di Windows né in una sessione interattiva. La funzione è pensata per righe di testo copiate: controlla ciò che incolli, soprattutto se il sorgente contiene rientri o sintassi di continuazione. Per modificare codice normalmente, il comando dell’editor per attivare o disattivare i commenti è di solito più facile da annullare e meno incline ad alterare la formattazione.