Prévisions météorologiques

Dans l'exercice précédent, on a vu qu'il existe deux façons d'écrire des commentaires en Go : les commentaires sur une seule ligne, précédés de //, et les blocs de commentaires multilignes, encadrés par /* et */.

Commentaires de documentation

En Go, les commentaires jouent un rôle important dans la documentation du code. Ils sont utilisés par la commande godoc, qui extrait ces commentaires pour créer la documentation des packages Go. Un commentaire de documentation doit être une phrase complète qui commence par le nom de l'élément décrit et se termine par un point.

Les commentaires doivent précéder les packages ainsi que les identifiants exportés, par exemple les fonctions exportées, les méthodes, les variables au niveau du package, les constantes et les structures, que tu découvriras plus en détail dans les prochains exercices.

Une variable au niveau du package peut ressembler à ceci :

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

Commentaires de package

Les commentaires de package doivent être écrits juste avant la clause package (package x) et commencer par Package x ..., comme ceci :

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

Commentaires de fonction

Un commentaire de fonction doit être écrit juste avant la déclaration de la fonction. Il doit s'agir d'une phrase complète qui commence par le nom de la fonction. Par exemple, un commentaire exporté pour la fonction Calculate doit prendre la forme Calculate .... Il doit aussi expliquer quels arguments la fonction prend, ce qu'elle en fait et ce que signifient ses valeurs de retour, en terminant par un point) :

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