Bevezetés
Az előző feladatban láttuk, hogy Go-ban kétféleképpen írhatunk kommentet: az egysoros kommenteket // előzi meg, a többsoros kommentblokkokat pedig /* és */ fogja közre.
Dokumentációs kommentek
Go-ban a kommentek fontos szerepet játszanak a kód dokumentálásában.
A godoc parancs használja őket: kinyeri ezeket a kommenteket, és dokumentációt készít belőlük a Go-csomagokról.
A dokumentációs kommentnek teljes mondatnak kell lennie, amely annak a nevével kezdődik, amit leír, és ponttal végződik.
A kommenteknek a csomagokat és az exportált azonosítókat is meg kell előzniük, például az exportált függvényeket, metódusokat, csomagszintű változókat, konstansokat és struktúrákat. Utóbbiakról a következő feladatokban tanulsz majd többet.
Egy csomagszintű változó így nézhet ki:
// TemperatureCelsius represents a certain temperature in degrees Celsius.
var TemperatureCelsius float64
Csomagkommentek
A csomagkommenteket közvetlenül a csomagra vonatkozó utasítás (package x) elé kell írni, és a Package x ... formával kell kezdődniük, például így:
// Package kelvin provides tools to convert
// temperatures to and from Kelvin.
package kelvin
Függvénykommentek
A függvénykommentet közvetlenül a függvénydeklaráció elé kell írni.
Legyen teljes mondat, amely a függvény nevével kezdődik.
Egy exportált függvény kommentje, például a Calculate esetében, a Calculate ... formát kövesse.
Azt is el kell magyaráznia, milyen argumentumokat vár a függvény, mit tesz velük, és mit jelentenek a visszatérési értékei, a végén ponttal):
// CelsiusFreezingTemp returns an integer value equal to the temperature at which water freezes in degrees Celsius.
func CelsiusFreezingTemp() int {
return 0
}
Utasítások
Goblinocus egy ország, amely nagyon komolyan veszi az időjárás-előrejelzést.
Mivel elismert, felelősségteljes és kiváló programozó vagy, megkértek, hogy írj egy programot, amely meg tudja jósolni Goblinocus különböző városainak aktuális időjárási viszonyait.
Akkor épp elfoglalt voltál, ezért inkább megkérted az egyik barátodat, hogy végezze el helyetted a munkát.
Egy idő után Goblinocus elnöke felvette veled a kapcsolatot, és azt mondta, hogy nem érti a barátod kódját.
Amikor megnézed a kódot, rájössz, hogy a barátod nem felelősségteljes programozóként járt el, és egyetlen megjegyzés sincs a kódban.
Úgy érzed, kötelességed tisztázni a programot, hogy a goblinok is megértsék.
1. Dokumentáld a package weather csomagot
Mivel a goblinok nem olyan okosak, mint te, elfelejtették, mit kellene a csomagnak tennie értük.
Írj egy megjegyzést a package weather csomaghoz, amely leírja annak tartalmát.
A csomaghoz tartozó megjegyzésnek be kell mutatnia a csomagot, és a csomag egészére vonatkozó információkat kell nyújtania.
2. Dokumentáld a CurrentCondition és CurrentLocation változókat
Goblinocus elnöke kicsit paranoiás, és attól tart, hogy a megjegyzés nélküli változókat az országuk elpusztítására használják.
Tisztázd a CurrentCondition és CurrentLocation csomagszintű változók használatát, és nyugtasd meg az elnököt.
Ez megmondja a csomag bármely felhasználójának, hogy milyen információt tárolnak a változók, és mit tudnak vele kezdeni.
3. Dokumentáld a Forecast() függvényt
Goblinocus előrejelző operátorai szeretnék tudni, mit csinál a Forecast() függvény (de ne mondd el nekik, hogyan működik, mert sajnos csak még jobban összezavarodnának).
Írj egy megjegyzést ehhez a függvényhez, amely leírja, mit tesz a függvény, de azt nem, hogyan csinálja.
Tanulófeladat
