GoDasturchi
Documentation Comments

Documentation Comments

Hujjatlashtirish izohlari

Go'da eksport qilingan (katta harfli) har bir funksiya, tur yoki o'zgaruvchi ustiga izoh yozish — kuchli odat. go doc va pkg.go.dev kabi vositalar bu izohlarni avtomatik hujjatga aylantiradi.

example.go
package main

import "fmt"

// Discount hisoblangan chegirma miqdorini foizda qaytaradi.
// amount manfiy bo'lsa, natija har doim 0 bo'ladi.
func Discount(amount int, isVIP bool) int {
	if amount < 0 {
		return 0
	}
	if isVIP {
		return amount * 20 / 100
	}
	return amount * 10 / 100
}

func main() {
	fmt.Println(Discount(1000, true))
}

Go'ning hujjat izohi qoidasi qat'iy va sodda: izoh to'liq gap bo'lib, aynan funksiya/tur nomi bilan boshlanishi kerak ("Discount hisoblaydi...", "discount hisoblaydi..." emas). Bu shunchaki uslub emas — go doc va IDE'lar buni tahlil qilib, chiroyli hujjat yaratadi, va nom bilan boshlanmagan izohlar noto'g'ri formatlangan deb hisoblanadi.

>_ Exercise

To'g'ri formatlangan hujjat izohini yozing.

  • IsValidEmail funksiyasi ustiga, uning nomi bilan boshlanadigan izoh yozing
  • funksiyaning o'zi: matnda "@" bor-yo'qligini tekshirsin

Stuck? Reveal a hint to help you.

Hints (0/3)

Key Takeaway

Key Takeaway:

Eksport qilingan har bir narsaning ustiga, uning nomi bilan boshlanadigan izoh yozing — bu go doc orqali avtomatik, foydali hujjatga aylanadi.

Finish
OUTPUT

$ go run main.go
Kodingizni ishga tushiring

Documentation Comments

Hujjatlashtirish izohlari

Go'da eksport qilingan (katta harfli) har bir funksiya, tur yoki o'zgaruvchi ustiga izoh yozish — kuchli odat. go doc va pkg.go.dev kabi vositalar bu izohlarni avtomatik hujjatga aylantiradi.

example.go
package main

import "fmt"

// Discount hisoblangan chegirma miqdorini foizda qaytaradi.
// amount manfiy bo'lsa, natija har doim 0 bo'ladi.
func Discount(amount int, isVIP bool) int {
	if amount < 0 {
		return 0
	}
	if isVIP {
		return amount * 20 / 100
	}
	return amount * 10 / 100
}

func main() {
	fmt.Println(Discount(1000, true))
}

Go'ning hujjat izohi qoidasi qat'iy va sodda: izoh to'liq gap bo'lib, aynan funksiya/tur nomi bilan boshlanishi kerak ("Discount hisoblaydi...", "discount hisoblaydi..." emas). Bu shunchaki uslub emas — go doc va IDE'lar buni tahlil qilib, chiroyli hujjat yaratadi, va nom bilan boshlanmagan izohlar noto'g'ri formatlangan deb hisoblanadi.

>_ Exercise

To'g'ri formatlangan hujjat izohini yozing.

  • IsValidEmail funksiyasi ustiga, uning nomi bilan boshlanadigan izoh yozing
  • funksiyaning o'zi: matnda "@" bor-yo'qligini tekshirsin

Stuck? Reveal a hint to help you.

Hints (0/3)

Key Takeaway

Key Takeaway:

Eksport qilingan har bir narsaning ustiga, uning nomi bilan boshlanadigan izoh yozing — bu go doc orqali avtomatik, foydali hujjatga aylanadi.