《go语言实战》笔记第三章-go doc（文档）

介绍

go中自带了编写文档相关的命令，文档有助于读懂代码，标记一些代码方便回忆，提高效率

命令行方式查看

如果在终端开发，可以使用go doc命令，这样不需要切换窗口

go doc [-u] [-c] [package|[package.]symbol[.method]]

使用这个命令，可以分层查看文档注释，最细可以到方法，注释的格式是/abc/ 和 //abc

如果要查看a包下的b结构体里的c方法的注释，命令为

a go doc b.c 

可视化界面浏览

首先启动文档服务

➜  lib godoc -http=:6060

这样就可以在localhost下的6060端口查看文档，就类似于常见的资源管理器操作，其内容就是根据环境变量路径下所有包生成的文档

自行生成文档

文档格式类似c,java，就是双斜线和/**/两种，在标识符上方写文档，之后它就会绑定到文档

示例文档

对于一些工具类方法，可能会需要写一些输入输出示例，或者传参格式，可以把代码写一个名为example_test.go的文件中，其中目标函数无参，输出写在//output下一行

package lib

import "fmt"

func Example() {
	sum:=Add(1,2)
	fmt.Println("1+2=",sum)
	//Output:
	//1+2=3
}