登录
首页 >  Golang >  Go问答

GoDoc 类型/结构函数的示例函数

来源:stackoverflow

时间:2024-04-25 20:30:39 232浏览 收藏

一分耕耘,一分收获!既然打开了这篇文章《GoDoc 类型/结构函数的示例函数》,就坚持看下去吧!文中内容包含等等知识点...希望你能在阅读本文后,能真真实实学到知识或者帮你解决心中的疑惑,也欢迎大佬或者新人朋友们多留言评论,多给建议!谢谢!

问题内容

问题

我编写了一些位于 *_test.go 文件中的示例函数,以帮助澄清独立公共函数的上下文,而不会出现问题。当为与类型相关的函数编写示例函数时,就会出现显示问题。

示例

这是我遇到的一个基本示例。

假设我们在 main.go 中有一个函数,如下所示:

type client struct {
  user string
  ip string
}

func (c *client) sendnotification(message string) error {
  return nil
}

我想在 main_test.go 中创建一个示例函数,如下所示

func examplesendnotification() {
  //showoff code here
}

vscode 针对该特定示例引发错误,指出“examplesendnotification 引用未知标识符:sendnotification”。另外,运行 godoc 时它不会作为示例出现。

我也尝试过这种格式:

func (c *Client) ExampleSendNotification() {
  //Showoff code here
}

但随后它只是将其作为 vscode 中的测试删除,并且没有出现


正确答案


我在写完这篇文章时找到了答案。我想我仍然会为其他人发帖。

诀窍是编写示例[类型]_[方法],因此实际上在我的示例中,它看起来像:

func ExampleClient_SendNotification() {
  //Showoff code here
}

终于介绍完啦!小伙伴们,这篇关于《GoDoc 类型/结构函数的示例函数》的介绍应该让你收获多多了吧!欢迎大家收藏或分享给更多需要学习的朋友吧~golang学习网公众号也会发布Golang相关知识,快来关注吧!

声明:本文转载于:stackoverflow 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>