我正在寻找一种在GoDoc中添加自动链接到Variable
的示例的方法:
我试图创建一个示例函数,以使其通过GoDoc自动链接到IsAValidQualifier
到文档的Variables
部分中……但是我不知道该怎么做!< / p>
这是我的文件qualified_name.go
package model
//...
// This is the variable where I want the to link the example
var IsAValidQualifier = regexp.MustCompile(`some_regexp_content...`).MatchString
func ValidQualifiedName(s string) bool {
return IsAValidQualifier(s)
}
我能够在名为ValidQualifiedName
的文件中为qualified_name_test.go
方法创建一个示例
func ExampleQualifiedName_ValidQualifiedName() {
// The example content
}
在相同的qualified_name_test.go
文件中,我尝试添加以下内容:
func ExampleIsAValidQualifier() {
// The example content
}
但是没有任何结果,除了我的示例出现在Examples
部分中,并且该链接上没有指向的事实。
我也曾尝试将测试文件更改为model_test.go
,但仍然没有结果...
因为变量引用了我曾经尝试过的函数MatchString(s string) bool
func ExampleIsAValidQualifier_MatchString() {
// The example content
}
可惜的是,仍然没有运气...
我知道这不是使用示例的常见情况,但是最后我的变量引用了一个函数,因此能够很好地使用它并正确记录它而无需添加诸如{{1} }。
那么我的问题是,我们能做到吗?我错过了什么吗?