godoc

2018-01-01 约 380 字预计阅读 1 分钟

生成文档

生成文档是很简单的，主要在package,方法等想要注释的地方写上注释即可。可以使用//或者/**/ 举例：

// this is model comment
package model

import "fmt"
// user struct comment
type User struct {
}

func (u User) Run() {
	fmt.Println(" user run")
}
// return the maxvalue between a and b
func GetMax(a, b int) int {
	if a > b {
		return a
	}
	return b
}

上面的代码中我们为包、结构体，函数都写了注释，这样即可。

查看文档

查看文档可以使用 godoc -http=:8080生产一个web服务，在localhost:8080即可查看文档

生产示例文档

除了以上的注释文档，我们还可以在文档中查看示例；

创建 example_test.go文件
为函数创建示例代码。创建ExampleGetMax函数，规则是Example+示例函数名
为方法创建示例代码。创建ExampleUser_Run函数，规则是Example + 结构体 + _方法名
在创建示例代码的时候还可以指定Output:标签

example_test.go

func ExampleUser_Run() {
	user := User{}
	user.Run()

}
func ExampleGetMax() {
	max:=GetMax(1,2)
	fmt.Println(max)
	//Output:
	//2
}

文档如下：

目录

godoc

生成文档

查看文档

生产示例文档