go doc 命令介绍

一：go doc 命令介绍

作用：打印出程序实体说明文档。后可不跟参数或一个参数或两个参数
格式：go doc 标记参数
标记和参数可以不填，

go doc
在 main 包下，执行 go doc 默认是不打印的，除非加上 -cmd 标记，后面会讲
在非 main 包下，执行 go doc 打印当前代码包文档及其程序实体列表（程序实体：变量、常量、函数、结构体以及接口）
go doc 标记
标记有如下：

标记	含义
-c	区分后跟参数的大小写，比如：go doc -c packageOne（默认不写是不区分大小写）
-cmd	加入此标记会使go doc命令同时打印出main包中的可导出的程序实体（其名称的首字母大写）的文档。默认下，这些文档是不会被打印的。
-u	加入此标记后会使go doc命令同时打印出不可导出的程序实体（其名称的首字母小写）的文档。默认下，这部分文档是不会被打印出来的。

go doc 参数
go doc 参数，比如：go doc http.Request 会输出 http 包下 Request 文档说明，也可以跟两个参数，见下
go doc 参数1 参数2，比如：go doc net/http Request ,需要说明的是第一个参数要写完整的导入路径，我个人理解就是在参数1 的范围下，打印出参数2的文档说明详情，其实此时 doc 和参数之间还可以加入标记，相当于打印文档时又加入了条件判断。

二：godoc 工具介绍

作用：其实也是用于查看文档的，但与 go doc 还是有区别的。
godoc 模式一： 不添加 -http 标记

比如：godoc fmt 此时会纯文本打印出代码包fmt及其中所有可导出的包级程序实体的声明、文档和例子。

若仅想查看 fmt 包下的 Printf 函数，可以这样写： godoc fmt Printf 这是后接两个参数，个人理解还是在参数1 的范围内打印出参数2 的文档内容。
若要打印多个可以这么写：godoc fmt Printf Println
若想查看代码的同时看示例代码：godoc -ex net/http FileServer
若文档格式是 html 格式，可以加上 -html 标记

godoc命令会去Go语言根目录和环境变量GOPATH包含的工作区目录中查找代码包。我们可以通过加入标记-goroot来制定一个Go语言根目录

godoc 模式二： 添加 -http 标记
可以理解为以 http 页面的形式查看文档
比如：godoc -http=:6060 ，然后在网络浏览器的地址栏中输入 http://localhost:6060 来查看以网页方式展现的Go文档了。这与官网的文档说明是一样的。这样我们就可以再不方便访问Go语言官方站点的情况下也可以查看Go语言文档。

其实 godoc 还有好多可带的标记参数，这里只举其中的一个，要查看全部可以，在命令下敲击： godoc

go doc 命令介绍相关推荐

puppet子命令介绍
puppet子命令介绍 # puppet -V //查看puppet的版本 # puppet help //查看puppet支持的一些子命令 # ...
linux下mknod命令介绍
2019独角兽企业重金招聘Python工程师标准>>> linux下mknod命令介绍 mknod - make block or character special files m ...
window下常用的doc命令
本文为转载,转载地址:http://blog.csdn.net/franktan2010/article/details/36456501 window下常用的doc命令 dir 用来显示一个目录下的 ...
第五课：系统目录及ls·文件类型及alias命令介绍
1.上过一次我们学习了单用户和救援模式及服务器秘钥登录等操作,而我们最终的目的还是要操作和使用linux系统,所以我们今天先初步学习linux的基本命令如下: 一·目录介绍 ls命令介绍 ...
linux系统防火墙相关问题及常用命令介绍
今天介绍关于linux系统防火墙:centos5.centos6.redhat6系统自带的是iptables防火墙,centos7.redhat7自带firewall防火墙,ubuntu系统使用的是u ...
linux vim编辑文本是 m,linux基础命令介绍四：文本编辑 vim
本文介绍vim(版本7.4)的一般用法 vim是功能强大的文本编辑器,是vi的增强版. vim [options] [file ..] 使用vim编辑一个文件的最常用命令就是: vim file 其中 ...
启动任务管理器命令符，doc命令
启动任务管理器命令符 cmd 启动任务管理器命令符 Calc 启动计算器 notepad 启动记事本 mspaint--------画图板 write----------写字板 dvdplay---- ...
常见网络命令介绍及使用
常见网络命令介绍及使用 ping 介绍参数说明使用例子 ipconfig 介绍参数说明使用例子 tracert 介绍参数说明使用例子 netstat 介绍参数说明使用例子 route ...
linux route 刷新_linux基础命令介绍十五：推陈出新
本文介绍ip.ss.journalctl和firewall-cmd,它们旨在代替linux中原有的一些命令或服务. 1.ip ip [OPTIONS] OBJECT COMMAND ip是iprout ...

go doc 命令介绍

一：go doc 命令介绍

二：godoc 工具介绍

go doc 命令介绍相关推荐

最新文章

热门文章