如何在Go代码中为方法和变量编写内联文档？

00jrzges 于 2023-09-28 发布在 Go

关注(0)|答案(2)|浏览(80)

在GO语言中有没有一些规则来记录方法和变量？
例如PHP

/**
 This method will increase parameter $b in 10 points
 @var int $b
 @return int

*/
public function someMethod($b){
    return $b+10;
}

在GO上是否有类似东西，或者我必须只使用上面的“// comment”方法而不使用任何@var或@return？

2条答案

你应该使用标准的//注解，因为这是官方文档工具godoc用来为你的go代码生成文档的。你可以看看这篇来自Golang官方博客的文章：http://blog.golang.org/godoc-documenting-go-code
我还发现这很有趣：https://godoc.org/github.com/natefinch/godocgo

你应该使用标准的//，并且第一个单词必须是函数包的名称（对于generator）。
golang文件：
请注意，此注解是一个完整的句子，以它所描述的元素的名称开头。这个重要的约定允许我们生成文档