Cara terbaik untuk memaut ke pakej lain dalam fail doc.go

editor php Baicao akan memperkenalkan kepada anda cara terbaik untuk memaut ke pakej lain dalam fail doc.go. Apabila kami menggunakan berbilang pakej dalam projek bahasa Go, kadangkala kami perlu merujuk dokumentasi pakej lain dalam fail doc.go. Dalam kes ini, kita boleh menggunakan arahan "go doc" untuk melihat dokumentasi, tetapi apakah cara yang lebih baik jika kita mahu memaut terus ke dokumentasi pakej lain dalam fail doc.go? Dalam artikel berikut, kami akan menerangkan secara terperinci bagaimana untuk mencapai matlamat ini.

Kandungan soalan

tidak berfungsi dalam doc.go 文件中编写包文档时，链接到另一个包中的文档的最佳方法是什么？不幸的是，引用导入包的常规方法在 doc.go fail kerana import yang tidak digunakan tidak dibenarkan.

// package foo docs in a doc.go file
// foo uses [bar.bar] types for doing things.
package foo

import "foo.com/jonathan/godoctest/bar" // unused import error here

Menggunakan laluan yang layak sepenuhnya memang berkesan, tetapi anda tidak akan mendapat dokumentasi yang paling mudah dibaca:

// Package foo docs in a doc.go file
// foo uses [foo.com/jonathan/godoctest/bar.Bar] types for doing things.
package foo

Ada penyelesaian?

Penyelesaian

Gunakan pembolehubah bernama _ untuk merujuk pengecam dalam pakej yang diimport (pengecam kosong)

// Package foo docs in a doc.go file
// foo uses [bar.Bar] types for doing things.
package foo

import "foo.com/jonathan/godoctest/bar"

var _ bar.SomeType // where bar.SomeType is a type
var _ = bar.Value // where bar.Value is a func, var, constant, ...

Hanya satu rujukan kepada pakej yang diimport diperlukan. Kod di atas menunjukkan cara yang berbeza untuk merujuk jenis atau nilai.

Atas ialah kandungan terperinci Cara terbaik untuk memaut ke pakej lain dalam fail doc.go. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!