Kādas ir Go piemēru funkcijas?

Key Takeaways

• Funkcijas Go piemēri ir pārbaudāmi koda fragmenti, kas kalpo kā dokumentācija un kurus var izmantot, lai pārbaudītu pareizību.
• Funkcijas piemēri atbilst nosaukšanas konvencijai, un tās var definēt pakotnēm, funkcijām, veidiem un metodēm.
• Funkcijas piemēri ir izpildāmi testi, un tos var izmantot, lai nodrošinātu uzticamu kodu un atjauninātu dokumentāciju.

Viena no Go priekšrocībām ir daudzās iebūvētās testēšanas un dokumentācijas funkcijas. To vidū ir ļoti noderīgs rīks, ko sauc par "piemēra funkcijām", kas var palīdzēt pārbaudīt kodu un izskaidrot to citiem.

Kā Go izstrādātājam jums vajadzētu precīzi saprast, kas ir paraugfunkcijas un kā tās izmantot, lai izveidotu apkopjamu programmatūru.

Kas ir paraugfunkcijas?

Funkcijas (vai piemēri) Golangā ir pārbaudāmi koda fragmenti, kurus varat pievienot pakotnei kā dokumentāciju un pārbaudīt pareizību. Piemēra funkcijas neņem parametrus un arī neatgriež rezultātu.

Iedomājieties, ka jums ir šādas lietas Pavairot funkcija jūsu projektā:

funcMultiply(a, b int)int {
return a * b
}

Funkcijas piemērs priekš Pavairot izskatīsies šādi:

funcExampleMultiply() {
 fmt.Println(Multiply(4, 5))
// Output: 2
}

Funkcijas piemērā funkciju pārbaudei izmanto līdzīgu nosaukumu piešķiršanas principu. Definējiet funkcijas piemēru, pievienojot funkcijas nosaukumu kā sufiksu "Piemēram", kā tas ir gadījumā PiemērsReizināt šeit.

Funkciju piemēru aplūkošana tuvāk

Kods iepriekšējā sadaļā parāda piemēra funkcijas pamatstruktūru. Piemērs ir nosaukums, funkcijas pamatteksts un izvēles izvades komentārs funkcijas beigās.

Kad pievienojat izvades komentāru, Go apkopo un izpilda piemēru, lai pārbaudītu tā pareizību, bet bez komentāra Go tikai kompilē piemēra funkciju, to neizpilda.

Varat definēt pakotnes, funkcijas, tipa un tipa piemēru piemēru.

Lai noteiktu piemērus dažādām entītijām, ir vajadzīgas dažādas pieejas.

1. Lai definētu pakotnes piemēru, vienkārši izsauciet savu funkciju Piemērs(), bez sufiksa. Piemēram, šeit ir pakotnes līmeņa piemērs:

   funcExample() {
    fmt.Println("Hello, world!")
   // Output:
   // Hello, world!
   }

2. Lai definētu funkcijas piemēru, vienkārši pievienojiet funkcijas nosaukumu kā sufiksu, kā jūs uzzinājāt iepriekš.

   funcExampleMultiply() {
    fmt.Println(Multiply(4,5))
   // Output: 2
   }
   

3. Lai definētu tipa piemēru, pievienojiet nosaukumu kā sufiksu Piemērs. Šeit ir piemērs:

   type MyStruct struct {
   // ...
   }
   funcExampleMyStruct() {
   // ...
   }
   

4. Un visbeidzot, konkrēta veida metodei ir jāpievieno tipa nosaukums, pasvītra un pēc tam metodes nosaukums. Šeit ir demonstrācija:

   func(m *MyStruct)MyMethod() {
   // ...
   }
   funcExampleMyStruct_MyMethod() {
   // ...
   }
   

Varat definēt vairākus entītijai piemērus, pievienojot papildu pasvītru un sufiksu, kas sākas ar mazo burtu. Piemēram, PiemērsReizināt_sekunde, PiemērsMyStruct_MyMethod_second.

Varat arī iegūt lielāku piemēru, lai izskaidrotu sarežģītu loģiku, izmantojot a visa faila piemērs.

Visa faila piemērs ir fails, kas beidzas ar _test.go un satur tieši vienu piemēra funkciju, bez pārbaudes vai etalona funkcijām un vismaz vienu citu pakotnes līmeņa deklarāciju. Parādot šādus piemērus, godoc parādīs visu failu. - Go dev emuārs

Programma Go atpazīst un apstrādā jūsu piemēra funkcijas atbilstoši tam, kā jūs tās definējat.

Jūs varat izmantot Nesakārtota izvade alternatīva izvades komentāriem. Tas ir īpaši noderīgi gadījumos, kad funkcija atgriež sarakstu, kas nav sagaidāms noteiktā secībā.

Koda dokumentēšana ar funkciju piemēriem

Funkcijas paraugi ir noderīgi gan dokumentācijas, gan testēšanas nolūkos. Piemēra funkcija parasti labāk izskaidro uzvedību nekā komentāri.

Tieši kā Java Javadoc, Go's iebūvēts dokumentācijas rīks, godoc, palīdz viegli dokumentēt kodu. Taču dažas bibliotēkas un funkcijas ir jādokumentē kopā, lai sniegtu pilnīgāku izpratni par to darbību. Piemēri novērš šo neveiksmi, jo tie var parādīt mijiedarbību starp dažādām paketes vienībām.

The godok rīks automātiski saista piemērus ar funkcijām, veidiem un pakotnēm, kurām tie pieder, atkarībā no jūsu specifikācijām. Tas arī iet vienu soli tālāk, ļaujot eksperimentēt dokumentācijas tīmekļa saskarnē.

Varat izmēģināt pakotni vai metodi tieši no dokumentācijas, pirms pat to izmantojat savā kodā.

Šajā attēlā ir parādīts piemērs json. Derīgs funkcija zem kodējums/json:

Piemēra funkciju izmantošana mērvienības pārbaudei

Go piemēru funkcijas ir arī izpildāmas pārbaudes. Kad palaižat ej pārbaudīt komandu, dzinējs izpilda visas piemēra funkcijas ar galīgo izvades komentāru un nodrošina, ka tā izvade atbilst komentāram.

Šī iespēja ir noderīga daudzos veidos. Tas var kalpot kā papildu slānis testēšana, lai nodrošinātu uzticamu kodu, tas arī palīdz jums sekot līdzi dokumentācijai, mainoties kodam.

Piemēram, ja veicat izmaiņas, kas ietekmē konkrētas funkcijas darbību un tās atgriežamo rezultātu. Ja neatjaunināsit piemēra izvades komentāru, lai tas atbilstu jaunajām izmaiņām, šī piemēra testi neizdosies.

Tas ļoti palīdz novērst novecojušu dokumentāciju, jo jūsu dokumentācija vienmēr būs atjaunināta ar kodu.

Piemēra funkcijas nodrošina uzticamu kodu un dokumentāciju

Dokumentācija ir būtiska programmatūras izstrādes sastāvdaļa, taču tikai dažas valodas nodrošina tik spēcīgu platformu, lai dokumentētu un pārbaudītu savu kodu.

Go komplektācijā ir viss nepieciešamais, lai izveidotu kvalitatīvu dokumentāciju savai programmatūrai, un piemēra funkcijas ir būtiska tā sastāvdaļa. Izmantojiet piemērus, lai palīdzētu lietotājiem un līdzstrādniekiem ātrāk pieņemt un saprast jūsu kodu.