当前位置: > > > > 通过私有结构类型编写Godoc来实现接口
来源:stackoverflow
2024-04-22 20:09:23
0浏览
收藏
学习Golang要努力,但是不要急!今天的这篇文章《通过私有结构类型编写Godoc来实现接口》将会介绍到等等知识点,如果你想深入学习Golang,可以关注我!我会持续更新相关文章的,希望对大家都能有所帮助!
问题内容
我编写了一个库及其带有私有结构的接口实现。在 godoc 中,结构体有界函数没有显示。我认为这是因为未公开的结构。但我的功能是通过接口公开的。有没有办法为它创建好的 go 文档?或者我应该解释接口减速部分的函数行为?
我添加了我编写的包的简单版本。这是真正的 go 库,我需要编写好的文档。
package printer import "fmt" // Printer is the interface to Print anything type Printer interface { // Print is a wrapper of "fmt.Println" Print(string) } type printer struct { prefix string } // Print prints the sent string with prefix func (p *printer) Print(s string) { fmt.Println(p.prefix,s) } // NewPrinter returns a Printer with sent prefix func NewPrinter(prefix string) Printer{ return &printer{ prefix: prefix, } }
正确答案
如果您必须记录私有结构的方法,请在返回它的函数上方执行此操作。一般来说,您还应该考虑在接口方法标题上方留下良好的注释。 Go 不会显示用户无法(直接)访问的内容的文档,并且不够智能,无法知道您可以通过界面访问它。
理论要掌握,实操不能落!以上关于《通过私有结构类型编写Godoc来实现接口》的详细介绍,大家都掌握了吧!如果想要继续提升自己的能力,那么就来关注公众号吧!