Previsioni del tempo

Nell'esercizio precedente abbiamo visto che in Go ci sono due modi per scrivere i commenti: i commenti su una sola riga, preceduti da //, e i blocchi di commenti su più righe, racchiusi tra /* e */.

I commenti di documentazione

In Go, i commenti hanno un ruolo importante nella documentazione del codice. Sono usati dal comando godoc, che li estrae per creare la documentazione dei pacchetti Go. Un commento di documentazione dovrebbe essere una frase completa che inizia con il nome dell'elemento descritto e termina con un punto.

I commenti dovrebbero precedere i pacchetti e anche gli identificatori esportati, ad esempio funzioni, metodi, variabili di pacchetto, costanti e struct esportati, che imparerai a conoscere meglio nei prossimi esercizi.

Una variabile a livello di pacchetto può avere questo aspetto:

// TemperatureCelsius represents a certain temperature in degrees Celsius.
var TemperatureCelsius float64

I commenti dei pacchetti

I commenti dei pacchetti dovrebbero essere scritti subito prima della clausola di pacchetto (package x) e iniziare con Package x ..., così:

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

I commenti delle funzioni

Un commento di funzione dovrebbe essere scritto subito prima della dichiarazione della funzione. Dovrebbe essere una frase completa che inizia con il nome della funzione. Ad esempio, un commento esportato per la funzione Calculate dovrebbe avere la forma Calculate .... Dovrebbe anche spiegare quali argomenti accetta la funzione, cosa ne fa e cosa significano i valori restituiti, terminando con un punto):

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