Question

在＜code＞doc.go＜/code＞文件中编写包文档时，链接到另一个包中的文档的最佳方式是什么？不幸的是，引用导入包的常规方法在doc.go文件中不起作用，因为不允许使用未使用的导入。

// 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

使用完全限定的路径确实有效，但不能获得最可读的文档：

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

有什么变通办法吗？

Answer 1

使用名为_的变量引用导入包中的标识符（空白标识符）

// 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, ...

只需要一个对导入包的引用。上面的代码显示了引用类型或值的不同方法。

友情链接