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

Question

在GO语言中记录方法和变量有什​​么规则吗？

例如在 php 上

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

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

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

Answer 1

您应该使用标准的//注释，因为名为 godoc 的官方文档工具将使用它来为您的 go 代码生成文档。您可以从官方 golang 博客中查看这篇关于它的帖子:http://blog.golang.org/godoc-documenting-go-code

我也发现这很有趣:https://godoc.org/github.com/natefinch/godocgo