Commenti in

Informazioni su Commenti

I commenti permettono di lasciare note nel codice senza influire su come viene eseguito. Un commento su una sola riga inizia con // in qualsiasi punto della riga. Il compilatore ignora tutto ciò che va da // alla fine di quella riga. Quando un commento segue il codice sulla stessa riga, viene spesso chiamato commento inline. Un commento su più righe inizia con /* e termina con */ in qualsiasi punto della riga. Il compilatore ignora tutto quello che sta in mezzo, su una o più righe.

// This is a single-line comment on its own line

x := 1 // This is an single-line comment inline with code
fmt.Println(x) // prints 1

/*
This is a valid
multiline comment.
*/

/* This is also a valid multi-line comment. */

I commenti hanno scopi diversi a seconda di dove compaiono.

Commenti nel codice

I commenti nel codice spiegano perché si fa qualcosa, non cosa si fa. Usali quando il motivo dietro una decisione non è evidente dal codice:

results = results[1:] // skipping the header row

Nella maggior parte dei casi, il codice scritto in modo chiaro si spiega da sé e non servono commenti. Ogni tanto è necessario che il codice faccia qualcosa di complesso o inaspettato: quel tipo di codice va commentato.

Commenti di documentazione

I commenti di documentazione servono a documentare un pacchetto, una variabile o una funzione. Questa documentazione è destinata ad altri programmatori che vogliono sapere come usare il codice. Dovrebbe spiegare, a grandi linee, cosa fa il codice e come usarlo. Non dovrebbe includere dettagli sul funzionamento interno del codice. I commenti di documentazione stanno direttamente prima di una dichiarazione, senza righe vuote che separino il commento dalla dichiarazione. godoc li analizza per generare la documentazione del pacchetto, come si può vedere su pkg.go.dev. Un commento di documentazione dovrebbe essere una frase completa, che inizia con il nome dell'identificatore e termina con un punto.

I commenti di documentazione sugli identificatori esportati (quelli che iniziano con una lettera maiuscola) compaiono nella documentazione generata. I commenti di documentazione sugli identificatori non esportati (quelli che non iniziano con una lettera maiuscola) non compaiono, ma possono comunque fornire un contesto utile all'interno del codice.

I commenti che documentano un pacchetto iniziano con il nome del pacchetto e descrivono cosa fa il pacchetto:

// Package kelvin provides tools to convert temperatures to and from Kelvin.
package kelvin

I commenti che documentano una funzione iniziano con il nome della funzione e descrivono cosa fa la funzione, compresi i suoi argomenti ed i valori restituiti:

// CelsiusFreezingTemp returns an integer value equal to the temperature at which water freezes in degrees Celsius.
func CelsiusFreezingTemp() int {
    return 0
}

I commenti che documentano una variabile iniziano con il nome della variabile e descrivono cosa rappresenta la variabile:

// TemperatureFahrenheit represents a certain temperature in degrees Fahrenheit.
var TemperatureFahrenheit float64

Per la specifica completa dei commenti di documentazione, vedi la guida alla documentazione di Go.