Tingkatkan dokumentasi dan pengujian kode Anda dalam satu langkah mudah dengan fungsi contoh.

Poin Penting

  • Contoh fungsi di Go adalah cuplikan kode yang dapat diuji yang berfungsi sebagai dokumentasi dan dapat digunakan untuk memverifikasi kebenarannya.
  • Contoh fungsi mengikuti konvensi penamaan dan dapat didefinisikan untuk paket, fungsi, tipe, dan metode.
  • Fungsi contoh adalah pengujian yang dapat dijalankan dan dapat digunakan untuk memastikan kode yang andal dan menjaga dokumentasi tetap terkini.

Salah satu kekuatan Go adalah kekayaan fitur pengujian dan dokumentasi bawaannya. Di antaranya adalah alat yang sangat berguna yang disebut "fungsi contoh" yang dapat membantu Anda memeriksa kode dan menjelaskannya kepada orang lain.

Sebagai pengembang Go, Anda harus memahami dengan tepat apa saja contoh fungsi dan bagaimana Anda dapat menggunakannya untuk membangun perangkat lunak yang dapat dipelihara.

Apa Contoh Fungsinya?

Fungsi contoh (atau contoh) di Golang adalah cuplikan kode yang dapat diuji yang dapat Anda tambahkan ke paket sebagai dokumentasi dan verifikasi kebenarannya. Fungsi contoh tidak mengambil parameter dan juga tidak memberikan hasil.

instagram viewer

Bayangkan Anda memiliki yang berikut ini Berkembang biak berfungsi dalam proyek Anda:

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

Contoh fungsi untuk Berkembang biak akan terlihat seperti ini:

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

Contoh fungsi menggunakan konvensi penamaan serupa untuk menguji fungsi. Tentukan contoh fungsi dengan menambahkan nama fungsi sebagai akhiran ke "Contoh", seperti halnya dengan Contoh Kalikan Di Sini.

Melihat Lebih Dekat Contoh Fungsi

Kode di bagian sebelumnya menunjukkan struktur dasar dari fungsi contoh. Contohnya adalah nama, isi fungsi, dan komentar keluaran opsional di akhir fungsi.

Saat Anda menambahkan komentar keluaran, Go mengkompilasi dan mengeksekusi contoh untuk memverifikasi kebenarannya, namun tanpa komentar, Go hanya mengkompilasi fungsi contoh, tidak mengeksekusinya.

Anda dapat menentukan contoh untuk sebuah paket, fungsi, tipe, dan metode pada suatu tipe.

Mendefinisikan contoh untuk entitas yang berbeda memerlukan pendekatan yang berbeda.

  1. Untuk menentukan contoh suatu paket, panggil saja fungsi Anda Contoh(), tanpa akhiran apa pun. Misalnya, berikut adalah contoh tingkat paket:
    funcExample() {
     fmt.Println("Hello, world!")
    // Output:
    // Hello, world!
    }
  2. Untuk menentukan contoh suatu fungsi, Anda cukup menambahkan nama fungsi sebagai akhiran seperti yang Anda pelajari sebelumnya.
    funcExampleMultiply() {
     fmt.Println(Multiply(4,5))
    // Output: 2
    }
  3. Untuk menentukan contoh suatu tipe, tambahkan nama sebagai akhiran Contoh. Berikut ini contohnya:
    type MyStruct struct {
    // ...
    }
    funcExampleMyStruct() {
    // ...
    }
  4. Dan terakhir, untuk metode pada tipe tertentu, Anda menambahkan nama tipe, garis bawah, dan kemudian nama metode. Berikut demonstrasinya:
    func(m *MyStruct)MyMethod() {
    // ...
    }
    funcExampleMyStruct_MyMethod() {
    // ...
    }

Anda dapat menentukan beberapa contoh untuk suatu entitas dengan menambahkan garis bawah tambahan dan akhiran yang diawali dengan huruf kecil. Misalnya, ContohMultiply_detik, ContohMyStruct_MyMethod_second.

Anda juga dapat memiliki contoh yang lebih besar untuk menjelaskan logika kompleks dengan menggunakan a contoh seluruh file.

Contoh file utuh adalah file yang berakhiran _test.pergi dan berisi tepat satu fungsi contoh, tidak ada fungsi pengujian atau benchmark, dan setidaknya satu deklarasi tingkat paket lainnya. Saat menampilkan contoh seperti itu, godoc akan menampilkan seluruh file. - Blog pengembang pergi

Mesin Go mengenali dan menangani fungsi contoh Anda sesuai dengan cara Anda mendefinisikannya.

Anda dapat menggunakan Keluaran tidak berurutan alternatif untuk komentar keluaran. Hal ini sangat berguna dalam skenario ketika fungsi Anda mengembalikan daftar yang tidak diharapkan dalam urutan tertentu.

Mendokumentasikan Kode Anda Dengan Contoh Fungsi

Fungsi contoh berguna untuk tujuan dokumentasi dan pengujian. Fungsi contoh biasanya lebih mampu menjelaskan perilaku dibandingkan komentar.

Seperti Javadoc Java, Ayo alat dokumentasi bawaan, godoc, membantu mendokumentasikan kode dengan mudah. Namun Anda sebaiknya mendokumentasikan beberapa pustaka dan fungsi bersama-sama untuk memberikan pemahaman yang lebih lengkap tentang cara kerjanya. Contoh menghilangkan kemunduran ini karena dapat menunjukkan interaksi antara berbagai unit dalam suatu paket.

Itu godoc alat secara otomatis mengaitkan contoh dengan fungsi, tipe, dan paket yang dimilikinya, bergantung pada spesifikasi Anda. Ini juga melangkah lebih jauh dengan mengizinkan eksperimen dalam antarmuka web dokumentasi.

Anda dapat mencoba suatu paket atau metode langsung dari dokumentasi bahkan sebelum menggunakannya dalam kode Anda.

Gambar ini menunjukkan contoh untuk json. Sah berfungsi di bawah pengkodean/json:

Menggunakan Fungsi Contoh untuk Pengujian Unit

Fungsi contoh Go juga merupakan pengujian yang dapat dieksekusi. Saat Anda menjalankan pergi tes perintah, mesin menjalankan setiap fungsi contoh dengan komentar keluaran akhir dan memastikan keluarannya cocok dengan apa yang ada di komentar.

Kemampuan ini berguna dalam banyak hal. Ini bisa berfungsi sebagai lapisan tambahan pengujian untuk memastikan kode yang andal, ini juga membantu Anda melacak dokumentasi Anda seiring perubahan kode Anda.

Misalnya, jika Anda membuat perubahan yang memengaruhi cara fungsi tertentu dijalankan dan hasil yang dikembalikannya. Jika Anda tidak memperbarui komentar keluaran dalam contoh agar sesuai dengan perubahan baru, pengujian untuk contoh tersebut akan gagal.

Ini sangat membantu dalam mencegah dokumentasi basi, karena dokumentasi Anda akan selalu terbarui dengan kodenya.

Contoh Fungsi Menghasilkan Kode dan Dokumentasi yang Andal

Dokumentasi adalah bagian penting dari pengembangan perangkat lunak, namun hanya sedikit bahasa yang memberi Anda platform yang kuat untuk mendokumentasikan dan menguji kode Anda.

Go hadir dengan semua yang Anda perlukan untuk membuat dokumentasi berkualitas untuk perangkat lunak Anda, dan fungsi contoh adalah bagian penting darinya. Gunakan contoh untuk membantu pengguna dan kolaborator mengadopsi dan memahami kode Anda dengan lebih cepat.