Care sunt exemplele de funcții în Go?

Recomandări cheie

• Exemple de funcții din Go sunt fragmente de cod testabile care servesc drept documentație și pot fi folosite pentru a verifica corectitudinea.
• Exemplele de funcții urmează o convenție de denumire și pot fi definite pentru pachete, funcții, tipuri și metode.
• Exemple de funcții sunt teste executabile și pot fi utilizate pentru a asigura codul fiabil și pentru a menține documentația la zi.

Unul dintre punctele forte ale Go este multitudinea de funcții de testare și documentare încorporate. Printre acestea se numără un instrument extrem de util numit „exemplu de funcții” care vă poate ajuta să vă verificați codul și să îl explicați altora.

În calitate de dezvoltator Go, ar trebui să înțelegeți exact ce sunt exemplele de funcții și cum le puteți utiliza pentru a construi software care poate fi întreținut.

Care sunt funcțiile de exemplu?

Exemple de funcții (sau exemple) în Golang sunt fragmente de cod testabile pe care le puteți adăuga la un pachet ca documentație și le puteți verifica pentru corectitudine. Exemplele de funcții nu preiau parametri și nici nu returnează un rezultat.

Imaginați-vă că aveți următoarele Multiplica funcția în proiectul dvs.:

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

Un exemplu de funcție pentru Multiplica va arata asa:

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

Exemplele de funcții folosesc o convenție de denumire similară pentru a testa funcțiile. Definiți un exemplu de funcție adăugând numele funcției ca sufix la „Exemplu”, așa cum este cazul cu Exemplu Înmulțire Aici.

O privire mai atentă la funcții de exemplu

Codul din secțiunea anterioară arată structura de bază a unui exemplu de funcție. Ceea ce alcătuiește un exemplu este numele, corpul funcției și un comentariu opțional de ieșire la sfârșitul funcției.

Când adăugați comentariul de ieșire, Go compilează și execută exemplul pentru a-i verifica corectitudinea, dar fără comentariu, Go compilează doar funcția exemplu, nu o execută.

Puteți defini un exemplu pentru un pachet, o funcție, un tip și o metodă pe un tip.

Definirea exemplelor pentru diferite entități necesită abordări diferite.

1. Pentru a defini un exemplu pentru un pachet, trebuie doar să vă apelați funcția Exemplu(), fără nici un sufix. De exemplu, iată un exemplu la nivel de pachet:

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

2. Pentru a defini un exemplu pentru o funcție, adăugați pur și simplu numele funcției ca sufix, așa cum ați învățat mai devreme.

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

3. Pentru a defini un exemplu pentru un tip, adăugați numele ca sufix la Exemplu. Iată un exemplu:

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

4. Și, în sfârșit, pentru o metodă pe un anumit tip, adăugați numele tipului, un caracter de subliniere și apoi numele metodei. Iată o demonstrație:

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

Puteți defini mai multe exemple pentru o entitate adăugând o liniuță suplimentară și un sufix care începe cu o literă mică. De exemplu, ExempluMultiply_second, ExempluMyStruct_MyMethod_second.

Puteți avea, de asemenea, un exemplu mai amplu pentru a explica logica complexă folosind a exemplu de fișier întreg.

Un exemplu de fișier întreg este un fișier care se termină în _test.go și conține exact un exemplu de funcție, fără funcții de testare sau benchmark și cel puțin o altă declarație la nivel de pachet. Când se afișează astfel de exemple, godoc va afișa întregul fișier. - Blogul go dev

Motorul Go recunoaște și gestionează funcțiile dvs. exemplu în funcție de modul în care le definiți.

Puteți folosi Ieșire neordonată alternativă pentru comentariile de ieșire. Acest lucru este util în special în scenariile în care funcția dvs. returnează o listă care nu este așteptată într-o anumită ordine.

Documentarea codului dvs. cu exemple de funcții

Exemple de funcții sunt utile atât pentru documentare, cât și pentru testare. O funcție de exemplu face de obicei o treabă mai bună de a explica comportamentul decât comentariile.

Exact ca Javadoc-ul lui Java, Du-te instrument de documentare încorporat, godoc, ajută la codificarea documentelor cu ușurință. Dar veți dori să documentați unele biblioteci și funcții împreună pentru a oferi o înțelegere mai completă a modului în care funcționează. Exemplele elimină acest dezavantaj, deoarece pot demonstra interacțiunile dintre diferitele unități ale unui pachet.

The godoc instrumentul asociază automat exemplele cu funcțiile, tipurile și pachetele cărora le aparțin, în funcție de specificațiile dvs. De asemenea, face un pas mai departe, permițând experimentarea în cadrul interfeței web a documentației.

Puteți încerca un pachet sau o metodă chiar din documentație, chiar înainte de a le folosi în codul dvs.

Această imagine prezintă un exemplu pentru json. Valabil functioneaza sub codificare/json:

Utilizarea de exemple de funcții pentru a testa unitatea

Funcțiile de exemplu Go sunt, de asemenea, teste executabile. Când rulați du-te la testare comanda, motorul rulează fiecare funcție exemplu cu un comentariu final de ieșire și se asigură că ieșirea sa se potrivește cu ceea ce este în comentariu.

Această capacitate este utilă în multe feluri. Poate servi ca un strat suplimentar de testare pentru a asigura codul fiabil, vă ajută, de asemenea, să urmăriți documentația pe măsură ce codul se modifică.

De exemplu, dacă faceți o modificare care afectează modul în care rulează o anumită funcție și rezultatul pe care îl returnează. Dacă nu actualizați comentariul de ieșire din exemplu pentru a îndeplini noile modificări, testele pentru acel exemplu vor eșua.

Acest lucru ajută foarte mult la prevenirea documentației învechite, deoarece documentația dvs. va fi întotdeauna la zi cu codul.

Exemple de funcții produc cod și documentație de încredere

Documentarea este o parte esențială a dezvoltării software, dar puține limbi vă oferă o platformă atât de puternică pentru a vă documenta și testa codul.

Go vine cu tot ce aveți nevoie pentru a crea documentație de calitate pentru software-ul dvs., iar funcțiile de exemplu sunt o parte vitală a acestui lucru. Folosiți exemple pentru a ajuta utilizatorii și colaboratorii să adopte și să înțeleagă codul dvs. mai rapid.