- 综合排序
- 最热优先
- 最新优先
Go——godoc命令简介
前言 godoc的一些简记 命令 godoc的列表 | godoc的chm下载 查看godoc的所有命令 `$ godoc -h` usage: godoc -http=localhost:6060 See http://golang.org/lib/godoc/analysis/help.html -goroot string Go root directory (default $ godoc -http=:8080 命令输入后是没有任何输出的,直接在浏览器上访问即可 chm下载 https://github.com/astaxie/godoc/downloads
15210编辑于 2024-08-14- 来自专栏后台全栈之路
如何写高大上的 godoc（Go 文档）
换句话说，每个人都可以写自己的 godoc 并且展示在 godoc.org 上，只需要遵从 godoc 的格式标准即可，也不需要任何审核动作。 本文章的目的是通过例子，简要说明 godoc 的格式，让读者也可以自己写一段高大上的 godoc。以下内容以我自己的 jsonvalue 仓库为例子。其对应的 godoc 在这里。 在实际应用中，godoc 可能可以指以下含义： https://godoc.org 中的内容 Go 开发工具安装之后，自带的一个命令，就叫做 godoc Go 工具包的文档以及生成该文档所相关的格式 我们从 而 godoc 命令的作用，则是可以让我们在本地建立一个属于自己的 godoc 网站服务（官方的 godoc 其实也基本上是用同一个工具建立起来的）。 godoc 一览 Go 秉承 “注释即文档” 的理念，符合 godoc 的文档均从 Go 代码中提取并生成。我们还是从 jsonvalue 的 godoc 来看，一个一个说明。
11.6K150编辑于 2022-03-19 - 来自专栏旅途散记
一文掌握 godoc的使用与规范
Godoc将使用注释的文本来形成包的文档(粒度是某个package，而不是具体到某个.go文件) 官方介绍 Godoc: documenting Go code Go 1.5之前godoc也是一个内置的命令 ，新版本的Go不再自带这个命令，需要go get golang.org/x/tools/cmd/godoc来安装，默认是安装到GOBIN 环境变量定义的目录中 godoc -http=127.0.0.1 ---- godoc个人项目 godoc默认展示的是官方标准库的内容，个人项目如何使用godoc生成文档？ 在此试验一下： 新建了一个godoc-demo项目，由于godoc默认解析的是goroot下的src目录，如果我们的项目没有在goroot/src下面，可以新建一个src目录，在该目录下进行git clone 可根据godoc的解析，一一与项目中的注释写法做对照 如何写高大上的 godoc（Go 文档） ---- 注释的写法与godoc的解析 关于注释的写法及在godoc解析后的样式，可参考官方文档 Go Doc
2.1K60编辑于 2023-06-18 - 来自专栏大猪的笔记
使用godoc快速上手生成易维护的文档
godoc利用函数、结构、包的注释生成文档。同时，可以利用一些约定的文件和函数命名方式，生成更细致的用例。非常方便也编译维护。 gomarkdoc@latest 运行godoc服务 godoc -http=0.0.0.0:8000 -play 此时，可以在浏览器中使用 0.0.0.0:8000查看文档网页。 这行注释在godoc中会被消除，而单独以Output的方式显示在下方。 导出为markdown 利用工具gomarkdoc可将godoc导出为本地markdown。 /try > try/godoc.md
39010编辑于 2024-06-13 - 来自专栏猫头虎博客专区
2011年03月31日 Go生态洞察：Godoc —— Go代码的文档化
今天，作为猫头虎博主，我要引领大家探索Go语言的神器——Godoc。 深入这篇文章，你将发现如何使用Godoc来维护和美化你的Go代码，使其通俗易懂，维护性更佳。 Go项目对此理念推崇备至，于是我们有了神器——Godoc。 正文 Godoc的工作原理 Godoc不仅解析Go源码，还包括注释，并生成HTML或纯文本文档。 例如，通过Godoc的Web界面，你可以从函数的文档跳转到其实现上，只需要一次点击。 为你的项目写文档 Godoc鼓励开发者在声明之前直接写下普通的注释来文档化类型、变量、常量、函数或包。 package sort 使用Godoc的优势 Godoc的最大优势在于它的简约。遵循上述的注释约定，你的Go代码就可以呈现出良好的文档。 任何安装在$GOROOT/src/pkg内的Go包以及GOPATH工作空间中的代码都可以通过Godoc的命令行和HTTP接口访问。 总结 Godoc工具展示了Go语言对文档化的重视。
21510编辑于 2024-04-09 - 来自专栏【腾讯云开发者】
作为Gopher，你知道Go的注释即文档应该怎么写吗？
换句话说，每个人都可以写自己的GoDoc并且展示在pkg.go.dev上，只需要遵从GoDoc的格式标准即可，也不需要任何审核动作。 本文章的目的是通过例子，简要说明GoDoc的格式，让读者也可以自己写一段高大上的godoc。 一、什么是GoDoc 顾名思义，GoDoc就是Go语言的文档。在实际应用中，godoc可能可以指以下含义： 在2019年11月之前，表示https://godoc.org中的内容。 Go开发工具的一个命令，就叫做godoc——下文直接以“godoc”指代这个工具。 目前的godoc和pkgsite有两个作用，一个是用来本地调试自己的GoDoc显示效果；另一个是在无法科学上网的时候，用来本地搭建GoDoc服务器之用。 二、godoc命令 我们从工具命令开始讲起吧。
1.4K20编辑于 2022-04-07 - 来自专栏后台全栈之路
作为 Gopher，你知道 Go 的注释即文档应该怎么写吗？
本文章的目的是通过例子，简要说明 GoDoc 的格式，让读者也可以自己写一段高大上的 godoc。以下内容以我自己的 jsonvalue 包为例子。其对应的 GoDoc 在这里。 ---- 什么是 GoDoc 顾名思义，GoDoc 就是 Go 语言的文档。 在实际应用中，godoc 可能可以指以下含义： 在 2019.11 月之前，表示 https://godoc.org 中的内容 现在 godoc.org 已经下线，会重定向到 pkg.go.dev，并且其功能也都重新迁移到这上面 ，一个是用来本地调试自己的 GoDoc 显示效果；另一个是在无法科学上网的时候，用来本地搭建 GoDoc 服务器之用。 GoDoc 语法 在 GoDoc 中，当前 package 的所有可导出类型，都会在 pkg.go.dev 页面中展示出来，即便某个可导出类型没有任何的注释，GoDoc 也会将这个可导出内容的原型展示出来
5.2K81编辑于 2022-03-19 - 来自专栏元坑昊思迹
【实用系列】Golang代码注释自动修复工具
最近，我发布了github上的第一个开源代码库：godoc-repair，地址为：https://github.com/xiaoyuanhao/godoc-repair。 网上找到了godoc自动生成工具：godoc-generate。这是一个用于自动生成代码注释的工具，它会在所有“Exported”内容前加一行注释：“... missing godoc. 这就是godoc-repair的由来，根据我设定的待修复内容，自动修复成规定的注释格式。工具介绍这里，简单介绍下godoc-repair，主要介绍下它可以修复的内容。 默认情况下，维持了godoc-generate的方式，预留了注释内容，格式为：// %s missing godoc.'%s'会自动添加上名字。 总结欢迎大家尝试godoc-repair，这是我在github上建立的第一个代码库。凡事都有第一次，希望它有点用。一起加油吧，各位。
1.9K42编辑于 2022-06-24 - 来自专栏猫头虎博客专区
2020年12月15日 Go生态洞察：重定向godoc.org请求到pkg.go.dev
重定向godoc.org到pkg.go.dev 社区在2020年1月份分享了一个目标，即最终将godoc.org的流量全部重定向到pkg.go.dev对应页面。 用户现在可以选择将自己的godoc.org请求重定向到pkg.go.dev。 下一步计划 此迁移的下一步是在2021年初，完成pkgsite/godoc.org-redirect里程碑追踪的工作后，将godoc.org的所有请求重定向到pkg.go.dev的相应页面。 ❓ 常见问题解答 godoc.org的URL会继续工作吗？ 是的！ api.godoc.org会继续工作吗？ 此过渡对api.godoc.org没有影响。在pkg.go.dev的API可用之前，api.godoc.org将继续服务。
27910编辑于 2024-04-09 - 来自专栏旅途散记
Golang实用进阶工具
/bytes" target="_blank"]; "context" [label="context" color="palegreen" URL="https://godoc.org/context " target="_blank"]; "crypto/rand" [label="crypto/rand" color="palegreen" URL="https://godoc.org/crypto " target="_blank"]; "fmt" [label="fmt" color="palegreen" URL="https://godoc.org/fmt" target="_blank"] ://godoc.org/net/url" target="_blank"]; "os" [label="os" color="palegreen" URL="https://godoc.org/os" ="https://godoc.org/syscall" target="_blank"]; "time" [label="time" color="palegreen" URL="https://godoc.org
55720编辑于 2023-09-05 - 来自专栏solate 杂货铺
mac下brew使用国内源安装go15brew 安装go15
(buildpath/"src/golang.org/x/tools").install resource("gotools") cd "src/golang.org/x/tools/cmd/godoc /" do system "go", "build" (libexec/"bin").install "godoc" end bin.install_symlink libexec/"bin/godoc" end test do (testpath/"hello.go").write <<~EOS package main was installed assert_predicate libexec/"bin/godoc", :exist? assert_predicate libexec/"bin/godoc", :executable?
2.4K10发布于 2020-12-28 - 来自专栏跟着asong学Golang
Go语言中结构体打Tag是什么意思？
Tag Documentation xml https://godoc.org/encoding/xml json https://godoc.org/encoding/json asn1 https: //godoc.org/encoding/asn1 reform https://godoc.org/gopkg.in/reform.v1 dynamodb https://docs.aws.amazon.com /go/spanner bson https://godoc.org/labix.org/v2/mgo/bson, https://godoc.org/go.mongodb.org/mongo-driver /bson/bsoncodec gorm https://godoc.org/github.com/jinzhu/gorm yaml https://godoc.org/gopkg.in/yaml.v2 mapstructure https://godoc.org/github.com/mitchellh/mapstructure parser https://godoc.org/github.com
1.4K50编辑于 2022-07-11 - 来自专栏烟草的香味
GO 文档笔记
今天找到了GO内置的文档工具: godoc. (我用的1.14.3版本貌似不是自带工具了, 需要安装(配置代理): go get golang.org/x/tools/cmd/godoc) 运行命令: godoc -http=:8888. BUG 可以对 bug 进行描述, godoc会自动识别并标识出来: // BUG(hujing): 对 bug 的描述信息 ? image-20200719161655341 Deprecated 已弃用的标识, 这个关键字看的太多了, 不过godoc并不会识别这个关键字, 主要是编译器识别. // Deprecated: 请使用 GO 既然已经提供了godoc这么好的工具, 那写文档就更是义不容辞的工作了. がんばる!!!
1.2K40发布于 2020-07-23 - 来自专栏全栈程序员必看
Google资深工程师深度讲解Go语言-测试与性能调优(八)
,比较有用 输入godoc 报错,bash: godoc: command not found, 原因:没有安装godoc 解决方法: 关于godoc 不是内部命令问题解决 首先，该命令无效的原因是go 1.13 版本后 移除了godoc相关的一些命令，因此需手动安装 下面是安装使用该命令的方法： 第一步 进入命令行 输入下面两行代码 go env -w GO111MODULE=on go env 第二步 命令行输入，安装godoc go get golang.org/x/tools/cmd/godoc 安装完成后即可使用godoc命令，生成文档 sudo apt-get install golang-doc //方法一 sudo apt-get install golang-go.tools //方法二 go get -v golang.org/x/tools/cmd/godoc //方法三 godoc -http=localhost:6060后, 直接在浏览器,访问 http://localhost:6060/pkg/ 用注释写文档 在测试中加入example 使用go doc/godoc 来查看
45610编辑于 2022-07-18 作为 Gopher，如何写好注释？
什么是godoc？ godoc是Go语言的文档工具，它直接解析Go源代码中的注释，生成美观的API文档。 从2019年开始，官方文档网站从godoc.org迁移到了pkg.go.dev，但核心原理不变——注释即文档。 与其它语言的文档工具不同，godoc不需要特殊的注释格式或标记符号，只需遵循简单的约定就能生成专业级文档。这种设计体现了Go语言的设计哲学——简单而有效。 使用godoc命令 godoc -http=:6060 -goroot=$(pwd) 访问http://localhost:6060/pkg/查看你的项目文档。 掌握godoc的使用，能让你的项目更加专业、更易于协作。
19110编辑于 2026-01-05- 来自专栏Golang语言社区
Golang优秀实用开源项目收集
pkg) go get gopkg.in/mgo.v2 http://labix.org/mgo mysql go get github.com/go-sql-driver/mysql https://godoc.org /github.com/go-sql-driver/mysql 3.缓存 redis go get github.com/garyburd/redigo/redis https://godoc.org/ github.com/garyburd/redigo/redis memcache go get github.com/bradfitz/gomemcache/memcache https://godoc.org /github.com/bradfitz/gomemcache/memcache 4.MQ go-nsq go get github.com/nsqio/go-nsq https://godoc.org
1.6K70发布于 2018-03-20 - 来自专栏站长运维
代码规范和文档编写
2.2 godoc 工具 Golang 提供了一个名为 godoc 的工具，它可以根据文档字符串自动生成文档。 我们可以通过运行 godoc -http=:6060 命令启动 godoc 服务器，然后在浏览器中访问 http://localhost:6060 来查看生成的文档。 同时，使用 godoc 工具和编写示例代码可以帮助其他人了解你的代码和使用方式。
58810编辑于 2023-11-28 - 来自专栏盛开在夏天的太阳
第八章 测试与性能调优--生成文档和测试示例代码
java也可以生成文档, 就像一个手册一样, 可以用来查看方法, 接口, 下面我们给go项目生成文档 godoc -http :6060 godoc如果没有需要下载 然后在浏览器打开http://localhost
42210发布于 2020-09-27 - 来自专栏Golang语言社区
搭建本地 golang 文档服务器
平时我们看 golang 文档的方式通常有： go doc <package> golang.org/pkg 或者国内的 godoc.golangtc.com/pkg/ 看源码，当然这是最好的方式，只是需要更多的时间和耐心 后来了解到，godoc -html <package> 可以生成 HTML 文档，所以就思考如何搭建本地的 localhost:3000/pkg 先取个名字，godocserver 步骤如下： 获取所有 golang built-in packages 名称 遍历所有 packages 运行 godoc -html <package> 保存所有文件，启动一个静态文件服务器 利用 Ruby 实现 步骤1
3.7K50发布于 2018-03-20 - 来自专栏技术杂谈
怎么禁用 vscode 中点击 go 包名时自动打开浏览器跳转到 pkg.go.dev
ui.navigation.importShortcut": "Definition" } ui.navigation.importShortcut接受的值: "Both" (默认,同时跳转定义并打开 godoc 链接) "Definition" (仅跳转定义处) "Link" (跳转 godoc 链接) 具体的操作步骤： 你可以通过点击右上角的齿轮图标，然后选择“Settings”来打开设置。
60810编辑于 2024-12-11
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号