微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

godoc的写法

一个不错的项目,可以用来学习godoc文档的写法

一些说明

  • 参考例子
func ExampleFoo()     // 作为Foo函数或者类型例子
func ExampleBar_Qux() // 作为Bar类型的Qux函数例子
func Example()        // 作为整个库的例子

通过这种规则,godoc将ExampleReverse函数对应到了Reverse这个函数

  • 扩展
func ExampleReverse()
func ExampleReverse_second()
func ExampleReverse_third()

通过增加 下划线+小写字母开头的单词作为后缀,一个函数可以对应多个例子

参考资料

https://blog.golang.org/examples
https://github.com/fluhus/godoc-tricks
https://pkg.go.dev/mod/github.com/fluhus/godoc-tricks
https://github.com/rongfengliang/golang-slug-learning
https://pkg.go.dev/github.com/rongfengliang/golang-slug-learning/v2@v2.0.6/pkg/id

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐