go语法--基础32--文档

一、生成文档命令

查看文档命令

go doc

生成文档命令

godoc -http :6060

帮助命令

go help doc 

二、生成示例代码

1. 示例文件名必须以_test结尾
	1. 如：stack_test
2. 示例函数必须以Example开头
	1. 如：ExampleStack_Pop
		1. 表示Stack的Pop函数的示例
3. 示例输入必须使用：
	1. // Output:
4. 可以使用go test命令执行示例文件

三、错误处理

3.1、‘godoc’ 不是内部或外部命令，也不是可运行的程序

解决办法

go get golang.org/x/tools/cmd/godoc

四、生成文档

godoc -http :6060
http://localhost:6060/pkg/

4.1、文档代码

stack.go

// 这是一个非常好用的栈结构
//
// 作者:周飞
//
// 时间：2021年06月08日
//
// 邮箱：在追踪
package Stack

// 一个先入先出栈
type Stack []int

// 入栈,将元素添加到头部
// 		案例:
//		s.Push(123)
func (s *Stack) Push(v int) {
	*s = append(*s, v)
}

// 出栈,将头部元素拿出来
func (s *Stack) Pop() int {
	head := (*s)[0]
	*s = (*s)[1:]
	return head
}
// 栈是否为空,返回false,yes
func (s *Stack) IsEmpty() bool {
	return len(*s) == 0
}

4.2、测试

五、生成示例

godoc -http :6060
http://localhost:6060/pkg/

5.1、示例代码

stack_test.go

package Stack

import "fmt"


func ExampleStack_Pop() {
	s := Stack{1}
	s.Push(2)
	s.Push(3)
	fmt.Println(s.Pop())
	fmt.Println(s.Pop())
	fmt.Println(s.IsEmpty())

	fmt.Println(s.Pop())
	fmt.Println(s.IsEmpty())
	// Output:
	// 1
	// 2
	// false
	// 3
	// true
}

5.2、测试