Прогноз погоди

У попередній вправі ми побачили, що в Go є два способи писати коментарі: однорядкові коментарі, яким передує //, і багаторядкові блоки коментарів, які обгортаються в /* та */.

Коментарі до документації

У Go коментарі відіграють важливу роль у документуванні коду. Їх використовує команда godoc, яка витягує ці коментарі, щоб створити документацію про пакети Go. Коментар до документації має бути повним реченням, яке починається з назви описуваної речі та закінчується крапкою.

Коментарі мають передувати пакетам, а також експортованим ідентифікаторам, наприклад експортованим функціям, методам, змінним пакета, константам і структурам, про які ми дізнаємося більше в наступних вправах.

Змінна рівня пакета може мати такий вигляд:

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

Коментарі до пакета

Коментарі до пакета слід писати безпосередньо перед пакетним реченням (package x) і починати з Package x ... ось так:

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

Коментарі до функції

Коментар до функції слід писати безпосередньо перед оголошенням функції. Він має бути повним реченням, яке починається з назви функції. Наприклад, експортований коментар до функції Calculate має мати форму Calculate .... Він також має пояснювати, які аргументи приймає функція, що вона з ними робить і що означають її повернені значення, і закінчуватися крапкою):

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