Go-知识 注释
- 行注释
- 块注释
- 包注释
- 结构体&接口注释
- 函数&方法注释
- 废弃注释
- 文档
在 go 语言中注释有两种，行注释和块注释
行注释
使用双斜线 // 开始，一般后面紧跟一个空格。行注释是Go语言中最常见的注释形式，在标准包中，一般都采用行注释，即使需要多行也尽量使用行注释。
块注释
以 /* 开头，以 */ 结尾，不能嵌套使用。块注释一般用于包描述或注释成块的代码片段。
包注释
在一个目录下任意一个go文件的 package 前面进行注释。
包注释一般用于生成 doc ，一般不会在 ide 进行展示
结构体&接口注释
函数&方法注释
废弃注释
随着代码迭代，有些代码不建议使用，但是直接删除成本又比较大，那么就会使用废弃注释，让IDE告诉开发人员，在使用的时候进行提示
文档
注释不仅仅在写代码时，在IDE进行展示，帮助开发人员更好的选择使用哪个调用，还能输出文档。
使用 go doc <package> 可以查看包的文档
使用 go doc <package.struct> 可以查看包下具体的文档
使用go doc <package.struct.method> 可以查看具体的方法或者函数的文档
除此之外，还可以使用 godoc -http :9393 查看HTML格式的文档
godoc 并不会自动安装，如果命令不识别，需要安装 mac :
brew install godocgodoc 在 1.20 版本被移出标准组件，使用
go install golang.org/x/tools/cmd/godoc@latest安装
使用 godoc -http :9393 后，会自动在命令执行目录下寻找 go.mod ，然后加载 go.mod
因为之前 自己的 go.mod 中的 package 的名字是 test 和标准库重复，所以在解析的时候，被认为是标准库之一了
这算不算是 godoc 的一个 bug 😆
因为 gostudy 包下都是test文件，所以不会进行渲染
将 文件名字进行修改
可以看到注释成功的展示了
再看看别的注释
这里有个优化的点，如果一个方法加了废弃注释，那么在文档展示的时候，是不是也可以加删除线(maybe 又是一个优化点 😆)
在gostudy包下加一个main 函数(因为不是一个真正的工程，存在多个 main 并且之间没有相互依赖关系)
