3.6. 生成代码文档

go doc 工具会从 Go 程序和包文件中提取顶级声明的首行注释以及每个对象的相关注释,并生成相关文档。

用法

go doc package 获取包的文档注释,例如:go doc fmt 会显示使用 godoc 生成的 fmt 包的文档注释。

go doc package/subpackage 获取子包的文档注释,例如:go doc container/list。

go doc package function 获取某个函数在某个包中的文档注释,例如:go doc fmt Printf 会显示有关 fmt.Printf() 的使用说明。

这个工具只能获取在 Go 安装目录下 ../go/src 中的注释内容。此外,它还可以作为一个本地文档浏览 web 服务器。在命令行输入 godoc -http=:6060,然后使用浏览器打开 http://localhost:6060 后,你就可以看到本地文档浏览服务器提供的页面。

了解更多有关godoc 的信息

©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

  • go build 这个命令主要用于编译代码。在包的编译过程中,若有必要,会同时编译与之相关联的包。 如果是普通包,...
    今早上阅读 664评论 0 3
  • 主要来源:《Go Web编程》 1、go build 作用:compile packages and depend...
    molscar阅读 493评论 0 0
  • 序 这篇文章主要介绍了Go语言命令行操作命令详细介绍,本文重点介绍了go build、go clean、go fm...
    技术学习阅读 1,354评论 0 7
  • 青纱罗账红襦袖 宫商角徵笙舞平 束发敛裾炉烟墙 相夫教子宜室家 饭蔬羹汤为子忙 肤容极妍待流沙 青丝成雪暮华发 一...
    川川在此阅读 252评论 0 1
  • 从哪说起呢?从我早上穿了条臭裤子,还是下楼崴了脚,还是出门撞了车?好,我们从头说,搬凳子的拿瓜子的赶紧准备,好戏开...
    橙儿妈阅读 433评论 1 1

友情链接更多精彩内容