Golds

GoldsGo local docs server)是一款实验性的本地Go文档服务器、Go文档生成器以及Go代码阅读器。

特性和当前版本的限制

请阅读项目主页以获取详情。

安装

如果程序名golds和其它程序冲突,也可将Golds程序安装为其它名称:

你也可以先将此项目代码克隆下来,然后进入相应的程序目录,运行go install来安装此程序。

(注意:Go程序的默认安装路径为GOBIN环境变量设置的路径。它的默认值为GOPATH环境变量指定的第一个路径下的bin子文件夹对应的目录。GOPATH环境变量的默认值为当前用户HOME目录下的go子文件夹对应的目录。请将Go程序默认安装路径配置在PATH环境变量中以便从任何目录运行安装的Go程序。)

使用说明

Golds 的主要用途是针对一个Go项目开启一个本地文档服务器,用来查看此项目的文档和源代码。我们可以

上述所用命令都将自动打开一个浏览器窗口用来浏览文档和代码。我们可以使用-s-silent选项来关闭这一行为。

Golds的第二个用途是使用-gen选项来生成一个项目的静态HTML文档。 比如:

其中的-dir选项的默认值为.(即当前目录)。 使用-nouses选项来避免生成的文档占用过多磁盘空间(减少特性换取空间)。

选项-source-code-reading用来控制如何生成源代码页面。支持的值:

选项-allow-network-connection用来指定在确定Go模块外部代码托管网站的时候是否可以进行网络连接。

主要的控制占用磁盘空间的选项:

golds -gen -compact ./...命令生成的文档占用的磁盘空间为golds -gen ./...命令的1/6,为golds -gen -nouses ./...命令的1/2。golds -gen -compact -source-code-reading=external ./...命令生成的文档占用的磁盘空间为golds -gen -compact ./...命令的1/5。

-wdpkgs-listing选项用来控制如何列出当前目录下的所有库包。它的值可以为:

Golds的第三个用途是作为文件服务器(Go local directory server)。 比如我们可以运行golds -dir=.(或者golds)来在浏览其中浏览当前目录的文件。 -s-silent选项在此用途中也有效。

golds命令可以识别GOOSGOARCH环境变量。


本Go101.org网站将推出一些其它Go学习和使用栏目(比如Go实战,Go测验,Go工具等),敬请收藏关注期待。

本书微信公众号名称为"Go 101"。此公众号将时不时地发表一些Go语言相关的原创短文。各位如果感兴趣,可以搜索关注一下。

本书的twitter帐号为@Golang_101。玩推的Go友可以适当关注。

《Go语言101》项目目前托管在Github上。欢迎各位在此项目中通过提交bug和PR的方式来改进完善Go语言101中的各篇文章。

你或许对本书作者老貘开发的一些App感兴趣。

赞赏
(本书由老貘历时三年写成。目前本书仍在不断改进和增容中。你的赞赏是本书和Go101.org网站不断增容和维护的动力。)