我最近在为客户做的项目中被介绍给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/