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

标签 go documentation

在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?

最佳答案

您应该使用标准的//注释,因为名为 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/

相关文章:

json.Unmarshal 嵌套对象成字符串或 []byte

go - 允许反射从 Go 中的结构中获取未导出的字段

javascript - 如何跟踪我的数据结构?

ios - "Auto Layout Help"主题在哪里?

swift - 将自定义文档添加到重写函数

language-agnostic - HACK 和 UNDONE 注释标签的使用

go - 通过 Go 客户端 API 列出 Openshift 对象

arrays - 如何在 Go 中保持强引用?

postgresql - 无法在容器之间建立连接

documentation - 谷歌语音 API 文档