godoc 查看开发者生成文档

Go 语言的文档

Go 语言有两种方法为开发者生成文档。如果开发人员使用命令行提示符工作，可以在终端上直接使用go doc 命令来打印文档。无需离开终端，即可快速浏览命令或者包的帮助。不过，如果开发人员认为一个浏览器界面会更有效率，可以使用godoc 程序来启动一个Web 服务器，通过点击的方式来查看Go 语言的包的文档。Web服务器godoc 能让开发人员以网页的方式浏览自己的系统里的所有Go 语言源代码的文档。

从命令行获取文档

对那种总会打开一个终端和一个文本编辑器（或者在终端内打开文本编辑器）的开发人员来
说，go doc 是很好的选择。假设要用Go 语言第一次开发读取UNIX tar 文件的应用程序，想
要看看archive/tar 包的相关文档，就可以输入：

go doc tar

执行这个命令会直接在终端产生如下输出：

PACKAGE DOCUMENTATION
package tar // import "archive/tar"
Package tar implements access to tar archives．It aims to cover most of the
variations, including those produced by GNU and BSD tars.
References:
http://www.freebsd.org/cgi/man.cgi?query=tar&sektion=5
http://www.gnu.org/software/tar/manual/html_node/Standard.html
http://pubs.opengroup.org/onlinepubs/9699919799/utilities/pax.html
var ErrWriteTooLong = errors.New("archive/tar: write too long") ...
var ErrHeader = errors.New("archive/tar: invalid tar header")
func FileInfoHeader(fi os.FileInfo, link string) (*Header, error)
func NewReader(r io.Reader) *Reader
func NewWriter(w io.Writer) *Writer
type Header struct { ..．}
type Reader struct { ..．}
type Writer struct { ..．}

开发人员无需离开终端即可直接翻看文档，找到自己需要的部分。

2．浏览文档

Go 语言的文档也提供了浏览器版本。有时候，通过跳转到文档，查阅相关的细节，能更容易理解整个包或者某个函数。在这种情况下，会想使用godoc 作为Web 服务器。如果想通过Web浏览器查看可以点击跳转的文档，下面就是得到这种文档的好方式。

开发人员启动自己的文档服务器，只需要在终端会话中输入如下命令(效果如下图)：

godoc -http=:6060

这个命令通知godoc 在端口6060 启动Web 服务器。如果浏览器已经打开，导航到http://localhost:6060 可以看到一个页面，包含所有Go 标准库和你的GOPATH 下的Go 源代码的文档。如果图 3-2 显示的文档对开发人员来说很熟悉，并不奇怪，因为Go 官网就是通过一个略微修改过的godoc 来提供文档服务的。要进入某个特定包的文档，只需要点击页面顶端的Packages。

Go 文档工具最棒的地方在于，它也支持开发人员自己写的代码。如果开发人员遵从一个简单的规则来写代码，这些代码就会自动包含在godoc 生成的文档里。为了在godoc 生成的文档里包含自己的代码文档，开发人员需要用下面的规则来写代码和注释。我们不会在本章介绍所有的规则，只会提一些重要的规则。

以上方法引用`《Go语言实战》的内容`，感兴趣的推荐阅读

godoc 查看开发者生成文档相关推荐

这款能够生成文档的接口测试软件，为什么越来越受欢迎？
之前进行接口测试一直用印度的postman,后来发现一款国产神器ApiPost,完全可以秒杀这个postman印度货.必须安利一波! 1.可以便捷的生成格式规范的文档记得以前当程序员的时候,每次写接 ...
【飞书应用】自动生成文档
飞书开放平台飞书开放平台,里面有关于飞书提供的一些供开发者使用的api,可以用来开发飞书的自定义应用,本次使用里面文档相关的api来自动生成文档创建飞书应用可以根据飞书官方文档,创建飞书应用,本 ...
Objective-C自动生成文档工具:appledoc
作者 iOS_小松哥关注 2016.12.13 15:47* 字数 919 阅读 727评论 10喜欢 35 由于最近琐事比较多,所以好久没有写文章了.今天我们聊一聊Objective-C自动生成文 ...
Objective-C 自动生成文档工具:appledoc
来源:iOS_小松哥 www.jianshu.com/p/fd4d8d6b6177 如有好文章投稿,请点击 → 这里了解详情由于最近琐事比较多,所以好久没有写文章了.今天我们聊一聊Objective ...
java前端目录_[Java教程]前端那点事儿——Tocify自动生成文档目录
[Java教程]前端那点事儿--Tocify自动生成文档目录 0 2016-06-29 22:00:07 今天偶然间看到文档服务器有一个动态目录功能,点击目录能跳转到指定的位置:窗口滑动也能自动更新目 ...
使用DocFX生成文档
使用DocFX命令行生成文档使用docfx 命令 1.下载 https://github.com/dotnet/docfx/releases 2.使用创建初始项目 docfx init -q 此命 ...
使用 apiDoc 为你的Node.js API 生成文档
翻译: 疯狂的技术宅原文:jonathas.com/documenting- 未经许可,禁止转载! 当你为其他开发人员(前端,桌面,移动等)开发 API 时,需要生成一份风格良好的文档,以便他们知道 ...
java 自动生成文档_[原]java开发文档的自动生成方式
对于Java注释我们主要了解三种: // 注释一行 /* ...... */ 注释若干行第三种,文档注释: /** ...... */ 注释若干行,并写入 javadoc 文档通常这种注释的多行写 ...
apidoc生成文档时报错
问题描述在书写完接口的时候,使用apidoc来生成我们所需要的接口文档的时候,输入apidoc.cmd -i ./constroller -o ./doc ,其中constroller 指定读取源文 ...

godoc 查看开发者生成文档

Go 语言的文档

以上方法引用`《Go语言实战》的内容`，感兴趣的推荐阅读

godoc 查看开发者生成文档相关推荐

最新文章

热门文章

godoc 查看开发者生成文档

Go 语言的文档

以上方法引用《Go语言实战》的内容，感兴趣的推荐阅读

godoc 查看开发者生成文档相关推荐

最新文章

热门文章

以上方法引用`《Go语言实战》的内容`，感兴趣的推荐阅读