Go文档管理和规范
目录
godoc
godoc -http=:8000 #开启本地文档服务器
Go文档注释规范
因为go的注释即文档，文档都是根据注释生成的，所以文档的详细性和合理性都必须要求注释必须符合一定的规范，这样才可以生成漂亮详细的文档
文档主要有如下几部分组成:
| 组成 | 作用 |
|---|---|
| Overview | 包含包的 import 语句和概要说明 |
| Index | 包含包中可见性为 public 的常量、类型、方法、函数的总目录及说明 |
| Constants | 项目所有的导出常量 |
| Variables | 显示所有全局变量 |
| Functions | 显示所有函数 |
| Types | 显示所有type |
Overview
用于整个项目的简单描述，又叫包文档
项目中一级目录下所有包头开始的注释内容的合并，这里需要注意注释和包名一行必须没有空格
一般如果包注释需要特别多的话则会将这些信息单独写在doc.go文件中，此文件专门用来记录包的描述信息，比如gin的doc.go下的内容为
/*
Package gin implements a HTTP web framework called gin.
See https://gin-gonic.com/ for more information about gin.
*/
package gin // import "github.com/gin-gonic/gin"
doc.go专门用于存放项目的Overview信息，不用于存放代码
Index
该项目列出了所有导出的结构体、函数、常量等名字以及超链接，用于索引该项目的所有函数、结构体等对象，其详细内容在相应的详细内容上，点击链接就可以看到具体函数详细的注释内容
Constants
const不可变得常量，需要注释在const之上
//My Name
const (
NAME="lyer"
AGE=18
)
Variables
var全局变量，和const注释规则一致
//My Name
var(
NAME="lyer"
AGE=18
)
具体内容注释
比如有一个函数、结构体、常量、全局变量等，注释在函数声明的上面，并且不能有空行这样才会显示在文档上，结构体也仅仅会展示公共属性
//BSTree is an ordered set items
type BSTree struct {
root *node
Length int //number of nodes
comp func(a, b interface{}) int //comparison function <0 0 >0 < = >
}
//Say Hello func
func SayHello() {
log.Println("hello")
}
文档访问地址
比如：
这些地址需要你手动访问，第一次访问时该库就会去自动拉代码生成文档，每次需要更新文档时再点击相关的跟新文档按钮即可同步最新的文档