Go语言之GO 语言注释

GO 语言注释

Go语言的注释主要分成两类，分别是单行注释和多行注释。
单行注释简称行注释，是最常见的注释形式，可以在任何地方使用以//开头的单行注释；多行注释简称块注释，以/开头，并以/结尾，且不可以嵌套使用，多行注释一般用于包的文档描述或注释成块的代码片段。

在 package 语句之前的注释内容将被默认认为是这个包的文档说明。

对于代码中的变量、常量、函数等对象最好也都加上对应的注释，这样有利于后期对代码进行维护

godoc 工具

godoc 工具会从 Go 程序和包文件中提取顶级声明的首行注释以及每个对象的相关注释，并生成相关文档，也可以作为一个提供在线文档浏览的 web 服务器，Go语言官网（https://golang.google.cn/）但是Go语言 1.13 版本移除了 godoc 工具，大家可以通过命令来获取 godoc 工具。由于防火墙的原因，国内的用户可能无法通过命令来获取 godoc 工具，这时候就需要大家来手动操作了。

go doc

godoc 工具还可以获取 Go 安装目录下 ../go/src 中的注释内容，并将这些注释内容整合到 web 服务器中供我们预览。在命令行输入，然后使用浏览器打开 http://localhost:6060 后，就可以看到本地文档浏览服务器提供的页面。