Go提供了两种查看文档的方式,一种是使用go doc命令在终端查看,这种适用于使用VIM等工具在终端开发的人员,它们不用离开终端,既可以查看想查看的文档,又可以编码。
第二种方式,是使用浏览器查看的方式,通过godoc命令可以在本机启动一个web服务,我们可以通过打开浏览器,访问这个服务来查看我们的Go文档。
从终端查看文档 这种方式适用于在终端开发的,它们一般不像离开终端,查完即可继续编码,这时候使用go doc命令是很不错的选择。 go doc的使用比较简单,接收的参数是包名,或者以包里的结构体、方法等。 在线浏览文档 go doc终端查看的方式,虽然也很便捷,不过效率不高,并且没有查看细节以及进行跳转,为此Go为我们提供了基于浏览器使用的网页方式进行浏览API 文档,我们只用点点鼠标,就可以查看了,还可以在方法、包等之间进行跳转,更简洁方便。
要想启动一个Web在线API文档服务很简单,使用godoc就可以了。 在线浏览API文档非常方便,只需要鼠标点击就可以了,还可以查看对应的源代码,示例代码,很方便,我们经常用的也是这个在线浏览方式。 生成自己的文档 Go文档工具,还有一个亮点,就是可以支持开发人员自己写的代码,只要开发者按照一定的规则,就可以自动生成文档了。
在我们编码中,文档就是注释,Go语言采用了和C、Java差不多的注释风格。一种是双斜线的方式,一种是斜线和星号的方式。
添加文档示例 我们在看很多官方API文档的时候,可以在文档里看到一些例子,这些例子会告诉我们怎么使用API。
示例代码文档 Go的文档工具非常强大,更多功能,我们可以使用帮助命令查看。