go - “标题”注释的目的

标签 go

我最近在为客户做的项目中被介绍给Go。他们已经建立了代码库,需要进行一些更改。
我注意到所有的方法,结构等等都有一些奇怪的类似于标题的注释,如下所示:

// SomeType ...
type SomeType struct {
    // impl
}

// SomeFunc ...
func SomeFunc() *Val {
    // impl
}
目的是什么?是否应该类似于JavaDocs?每个此类评论末尾的三个点是什么意思?我的IDE(GoLand)识别名称,并将其转换为指向下面实现的链接。确实如此解析和处理它的事实使我认为它很重要。

最佳答案

是否应该类似于JavaDocs?

不错的猜测!
这是“Godoc”,是特殊格式的注释,被godoc工具视为文档。您可以在Go Blog:Godoc: documenting Go code上了解其工作原理。

关于go - “标题”注释的目的,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/63656546/

相关文章:

go - 无法使用客户端提供的 id_token 在服务器中使用 Oauth2 获取用户个人资料信息

arrays - 构建对象的Json对象并将其写入文件

templates - Go模板遍及结构的结构

go - 被嵌入在golang结构中的接口(interface)所困惑

go - 检测同一个 goroutine 连续两次调用 sync.Mutex.Lock()

parsing - time.Parse 自定义布局

macos - go: http 服务器在 osx 上不工作

go - 为了将 io.Reader 的内容作为字符串指针返回,我可以复制数据的最小次数是多少?

go - 函数/结构/接口(interface)名称中允许使用哪些字符?

pointers - 分配嵌入的 Struct 类型值