пакет тестирования The Go упоминает example functions как в:Что такое функции примера?
func Example() { ... }
func ExampleF() { ... }
func ExampleT() { ... }
func ExampleT_M() { ... }
Какой смысл и использовать случай для них?
Примеры функций - это примеры использования пакета или функций или другого документа, который вы документируете. Примеры функций будут включены в сгенерированный godoc в исходной форме (в то время как другие функции не являются), с надлежащим форматированием, а также с некоторой обработкой, например, если последняя строка функции примера содержит выходные данные в формате:
func ExampleExamples_output() {
fmt.Println("Hello")
// Output: Hello
}
Последняя строка, определяющая выход, будет разделена и отображена в отдельном блоке, как показано ниже: Example (Output).
Также, если выход предоставлен: запуск набора тестов пакета (например, с помощью go test) также выполняет примерные функции без дополнительной настройки от вас, а Go сравнивает вывод функции примера с выходом, указанным в последней строке комментария - результат этого будет определять, проходит ли этот пример как «тест». Если вывод не указан в примере функции, go test будет компилировать его, но не выполнит.
Заканчивать эту страницу: package godoctricks
Также блог статья была опубликована о Пример функций:
Я не вижу ничего в неясности в документации вы ссылку. ИМО, ваш вопрос эквивалентен чему-то вроде «spec упоминает« int », в чем смысл и прецедент для этого?» то есть туманным/базовым или без реального вопроса, как бесполезным. –
@ Ответы icza были на месте. В документах не упоминается, что примерные функции используются с 'godoc', поэтому мне было непонятно, для чего вы их будете использовать. – Calin