Как добавить пример в раздел Variables документации godoc - PullRequest
Новая
       16

Как добавить пример в раздел Variables документации godoc

0 голосов
/ 22 ноября 2018

Я ищу способ добавить пример , автоматически связанный с Variable в моем GoDoc:

Я попытался создать пример функции, чтобы она былаGoDoc автоматически связывается с IsAValidQualifier в разделе Variables документации ... Но я не могу понять, как это сделать!

Вот содержимое моего файла 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
}

Но, к сожалению, по-прежнему не повезло счто ...

Я знаю, что это не обычный случай, чтобы использовать пример, но в конце концов мойariable относится к функции, поэтому было бы неплохо иметь возможность использовать ее и правильно документировать, не добавляя дополнительную функцию, такую ​​как ValidQualifiedName(s string).

Тогда мои вопросы: можем ли мы это сделать;я что-то пропустил?

...