Golang注释与godoc详解

　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　作者：尹正杰

版权声明：原创作品，谢绝转载！否则将追究法律责任。

目录

• 1.注释的形式
• 2.注释的位置
• 3.godoc

1.注释的形式

- 单行注释:
	以"//"开头。
	
- 多行注释:
	连续多行以"//"开头，或者在段前使用"/*"，段尾使用"*/"。
	
温馨提示:
	注释时可以使用一些关键字来做一些相关约定:
		NOTE: 
			引人注意
		TODO: 
			将来需要优化
		Deprecated: 
			变量或函数强烈建议不要再使用。

2.注释的位置

包注释:
	在"package xxx"的上方，一个包只需要在一个地方写注释，通常会专门写一个"doc.go"，里面只有一行"package xxx"和关于包的注释。
	
结构体注释:
	在"type XXX struct"上方。
	
函数注释:
	在"func xxx()"上方。
	
行注释:
	在行上方或右侧。

3.godoc

godoc可以为项目代码导出网页版的注释文档

godoc使用指南:
	1.初始化模块
go mod init yinzhengjie

	2.配置GOPATH变量
export GOROOT=/Users/yinzhengjie/golang/go
export GOPATH=/Users/yinzhengjie/golang/gosubjects/src/gocode
export PATH=$PATH:$GOROOT/bin:$GOPATH/bin

	3.修改GOPROXY变量为国内站点
go env -w GOPROXY=https://goproxy.cn,direct

	4.下载第三方依赖包godoc
go get -u golang.org/x/tools/cmd/godoc

	5.安装godoc工具
go install golang.org/x/tools/cmd/godoc@latest
	
温馨提示:
	上述命令执行完成后，会在"$GOPATH/bin"目录下多出来一个godoc命令哟，如果想要所有位置执行，请将其加入系统环境变量。

	6.启动http
godoc -http=:8080
	
	7.如上图所示，用浏览器访问页面
http://127.0.0.1:8080