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

有一些规则可以用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？

最佳答案

您应该使用标准的//注释，因为这是称为godoc的官方文档工具将用来为go代码生成文档的工具。您可以在golang官方博客上查看有关此帖子的信息:http://blog.golang.org/godoc-documenting-go-code

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

关于go - 如何编写Go代码中方法和变量的内联文档？，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/23268729/