Comentarii în Go
Comentariile sunt note pentru oameni: compilatorul le ignoră complet. Cu ele explici de ce ai scris codul așa, lași indicații colegilor sau oprești temporar o linie.
Comentariul pe o linie: //
Tot ce urmează după // până la finalul rândului este comentariu. Poate sta pe un rând separat sau la finalul unei instrucțiuni:
package main
import "fmt"
func main() {
// Afișăm mesajul de bun venit
fmt.Println("Bun venit!") // apare în consolă
}Bun venit!
În consolă apare doar Bun venit!. Comentariile nu se afișează și nu încetinesc programul: compilatorul le elimină.
Scrie un program care conține ambele tipuri de comentarii (// și /* */) și afișează un singur mesaj: Comentariile nu se afișează.
- Pune un comentariu // deasupra lui func main sau în interiorul ei.
- Adaugă un comentariu /* ... */ (pe una sau mai multe linii).
- Afișează mesajul cu fmt.Println.
Soluția exercițiului
package main
import "fmt"
// main afișează un mesaj despre comentarii.
func main() {
/*
Acest comentariu are
mai multe rânduri.
*/
fmt.Println("Comentariile nu se afișează") // doar acest text apare
} Vrei să afli mai mult?Comentariul pe mai multe linii: /* */ · Comentariul deasupra funcției · Cod comentat nu rulează · Comentarii bune și greșeli frecvente · Unde se folosesc comentariile
Comentariul pe mai multe linii: /* */
Pentru un text mai lung poți folosi /* la început și */ la final. Tot ce e între ele este ignorat, oricâte rânduri ar avea:
package main
import "fmt"
func main() {
/*
Programul calculează totalul unei comenzi.
Autor: echipa magazinului
*/
fmt.Println("Total:", 120+80)
}Total: 200
În practică, programatorii Go folosesc aproape mereu //, chiar și pe mai multe rânduri la rând. /* */ apare mai rar, de obicei la începutul unui fișier.
Comentariul deasupra funcției
În Go există o convenție: deasupra unei funcții scrii un comentariu care începe cu numele funcției și spune ce face. Uneltele Go (de exemplu go doc) transformă aceste comentarii în documentație.
package main
import "fmt"
// main pornește aplicația și afișează starea ei.
func main() {
fmt.Println("Aplicația rulează")
}Aplicația rulează
Cod comentat nu rulează
Dacă pui // în fața unei instrucțiuni, ea devine comentariu și nu se mai execută. E un truc folosit când vrei să oprești temporar o linie fără s-o ștergi:
package main
import "fmt"
func main() {
fmt.Println("Linia 1")
// fmt.Println("Linia 2")
fmt.Println("Linia 3")
}Linia 1 Linia 3
Linia 2 lipsește din rezultat: pentru compilator ea nu există.
Comentarii bune și greșeli frecvente
- Explică de ce, nu ce: // TVA-ul se aplică doar clienților din România e util; // afișez deasupra lui fmt.Println nu spune nimic nou.
- **/* neînchis**: dacă uiți */, tot restul fișierului devine comentariu, iar compilatorul raportează comment not terminated.
- **/* */ nu se pot pune unul în altul**: primul */ închide comentariul.
- **// în interiorul unui text** nu e comentariu: fmt.Println("https://go.dev") afișează adresa întreagă.
Codul se citește mult mai des decât se scrie. Un comentariu scurt bine plasat te ajută și pe tine peste o lună.
Unde se folosesc comentariile
Colegii înțeleg rapid de ce o regulă de business arată într-un anumit fel.
go doc și site-ul pkg.go.dev afișează comentariile de deasupra funcțiilor.
Comentezi temporar o linie ca să vezi ce se schimbă.
Pe scurt: // comentează până la finalul rândului, /* ... */ comentează un bloc; comentariile nu se afișează niciodată.
