关于golang如何生成文档

go语言自带的文档生成十分好用

下面我们来看看具体怎么操作

 

我们先来看一个没有任何注释的一个先进先出的队列例子

package queue

type Queue []interface{}

func (p *Queue) Push(v interface{}){
	*p = append(*p,v.(int))
}
func (p *Queue) Pop() interface{}{
	head := (*p)[0]
	*p = (*p)[1:]
	return head
}
func (p *Queue) IsEmpty() bool{
	return len(*p) == 0
}

接下来我们打开powershell（cmd或者linux，mac都可以）输入go doc

 

 这样我们就打开了系统自带的文档 一般情况下我们都是使用ide查看文档 这个只是作为了解使用

不过命令行有一个godoc -http :6060非常好用  我们可以使用 godoc -help打开godoc帮助文件 里面有详细介绍