Previsão do tempo

No exercício anterior, vimos que há duas formas de escrever comentários em Go: comentários de uma só linha, precedidos por //, e blocos de comentários com várias linhas, delimitados por /* e */.

Comentários de documentação

Em Go, os comentários desempenham um papel importante na documentação do código. São usados pelo comando godoc, que extrai esses comentários para criar documentação sobre os pacotes de Go. Um comentário de documentação deve ser uma frase completa que começa com o nome daquilo que está a ser descrito e termina com um ponto final.

Os comentários devem preceder tanto os pacotes como os identificadores exportados, por exemplo funções exportadas, métodos, variáveis de pacote, constantes e structs, sobre os quais vais aprender mais nos próximos exercícios.

Uma variável ao nível do pacote pode ter este aspeto:

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

Comentários de pacote

Os comentários de pacote devem ser escritos imediatamente antes de uma cláusula de pacote (package x) e começar por Package x ..., assim:

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

Comentários de função

Um comentário de função deve ser escrito imediatamente antes da declaração da função. Deve ser uma frase completa que começa com o nome da função. Por exemplo, um comentário exportado para a função Calculate deve ter a forma Calculate .... Deve também explicar que argumentos a função recebe, o que faz com eles e o que significam os seus valores devolvidos, terminando com um ponto final):

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