golang注释

• 单行注释

//

可以是单独的一行，也可以是在某个语句的后面。

比如：

• 多行注释

代码块的注释包的文档型描述

比如：

golang 文档描述

在进行项目开发的时候，代码的注释是必不可少的，但是对于go来说，自定义包及其包中对外暴露的函数，添加额外的特殊说明，方便使用者快速了解使用。

这种特殊的说明就是文档描述，书写有要求规范

• 包描述

packagePackage

• 函数描述

func SomeName()Function

go doc 工具

go doc 命令是基于go命令的。主要的作用是打印出go程序的文档信息，就是我们上面的所讲的文档描述。

go help sub-commandgo help doc
go doc

• go doc strconv

直接后面跟 包 名称，可以查看包中都有哪些对外暴露的方法、变量等

• go doc strconv ParseFloat

后面跟 包名 加 对应的方法名、变量名等，可以查看具体的说明和用法

• go doc 后面不添加任何参数

会打印当前目录所代表的代码包的文档及当中的包级别程序实体的列表

go doc 参数说明

不可导出可导出可导出main

godoc 和 go doc 傻傻分不清楚

godoc 和 go doc 很像，但是不一样哦~

go docgodocGOBIN

启动本地web访问在线文档的方式

http://localhost:8080
godoc http