godoc安装与自动生成API文档

最新推荐文章于 2022-11-22 22:00:07 发布
最新推荐文章于 2022-11-22 22:00:07 发布
阅读量614 收藏 1
点赞数
分类专栏： 服务计算
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/STcyclone/article/details/112380397
版权

先使用命令go get golang.org/x/tools/cmd/godoc来安装godoc。该命令会访问官网下载godoc，有可能访问超时。为此，需要在Bash下设置如下的环境变量：

export GOPROXY=https://goproxy.io
export GO111MODULE=on

这样就可以顺利安装godoc：
在这里插入图片描述
然后在bash下运行命令go build golang.org/x/tools/cmd/godoc
在这里插入图片描述

再运行godoc就可以在浏览器通过http://localhost:6060/来访问godoc了。
在这里插入图片描述
在这里插入图片描述

之后，还可以将文档导出出来：

godoc -url "http://localhost:6060/pkg/gitee.com/alphabstc/readcfg/readcfg" > api.html

在这里插入图片描述

STcyclone
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Go 利用 godoc 自动生成 API 文档
KianKwok的博客
10-19 1841
Go 利用 godoc 自动生成 API 文档 背景 在课程项目中需要完成 API 文档，自己写的文档不够规范且没有模版。后来了解到可以通过 godoc 自动生成 API 文档，十分方便。 环境说明 操作系统：Ubuntu 18.04.4 LTS (GNU/Linux 4.15.0-96-generic x86_64) 编辑器：vim 编译工具：go version go1.10.4 linux/amd64 过程 下载一个 go 项目作为实例。 go get github.com/go-ini/ini
godoc-tricks：使用godoc工具的技巧
02-05
godoc是Go语言生态系统中的一个强大工具，用于生成和查看Go代码的文档。它不仅可以帮助开发者轻松地了解库、包和程序的API，还可以作为本地的HTTP服务器运行，供开发者在编写代码时实时查看文档。在本文中，我们将...
golang中的godoc使用简介
猛犸象
10-26 2033
golang中的godoc使用简介
Go godoc 自动生成 API 文档
hllyzms的博客
01-20 1823
参考：Go 利用 godoc 自动生成 API 文档 https://blog.csdn.net/KianKwok/article/details/109166906 beego自动化文档 https://www.jianshu.com/p/0d375f4b36b2 Go——godoc命令简介 https://www.cnblogs.com/wangyang0210/p/11064128.html ...
eclipse在线安装golang插件,并配置
weixin_33834910的博客
04-02 544
2019独角兽企业重金招聘Python工程师标准>>> ...
go环境与开发工具配置
u010519674的专栏
09-19 248
go 环境安装，开发工具集成测试
goalng 工具包安装
choulongtun5848的博客
04-28 168
golang工具包的安装 以 安装godoc 为例： 1. godoc 源码下载 ...
goclipse godoc.exe
04-24
Godoc是Go语言的标准库之一，用于生成和查看Go项目的API文档。godoc.exe是这个工具的可执行文件，它能够帮助开发者在命令行界面中查看Go包、函数、类型、变量等的文档说明，也可以启动一个本地Web服务器，提供网页...
【最新版】Dash.zip【亲测可用】最好的API文档集
06-19
Dash使Mac可以立即脱机访问200多个API文档集。 Dash是API文档浏览器和代码段管理器。短跑即刻搜索离线文件集200层+的API，100+小抄和更多。您甚至可以生成自己的文档集或请求包含文档集。 Dash与程序包管理器集成，...
codeDocToMarkdown:Markdown 从你的代码中生成（Javadoc、GoDoc）
06-04
在软件开发领域，Markdown经常用于编写项目的README文件、API文档或者代码注释，因为它简洁、直观且易于阅读。 标题中的"codeDocToMarkdown"是一个工具，它的主要功能是从Java的Javadoc或Go语言的GoDoc中提取文档...
一个全面的godoc指南.zip
最新发布
05-25
解压后，`godoc-tricks_master`目录下可能有多个示例项目，每个项目都展示了不同的`godoc`使用技巧，比如如何编写高质量的API文档，如何使用`godoc`的`-h`、`-private`、`-v`等选项，以及如何自定义`godoc`的输出...
osgi框架和spring区别_面试才刷面试题？Spring160道面试题+Spring书籍助你学Spring，查漏补缺！...
weixin_39853523的博客
11-26 363
欢迎关注专栏《Java架构筑基》——专注于Java技术的研究与分享！Java架构筑基​zhuanlan.zhihu.comJava架构筑基——专注于Java技术的研究与分享！后续文章将首发此专栏！欢迎各位Java工程师朋友投稿和关注虽名为"面试题"，但一定要面试前才刷面试题嘛？其实在日常工作中多刷一些面试题对自己也是挺有帮助的！为此笔者收集了160道Spring中高级面试题给大家学习，查漏补缺！另...
Go语言注释的定义及使用（godoc工具提取注释内容）
xyz的专栏
09-05 754
注释在程序中的作用是对程序进行注解和说明，便于对源码的阅读。编译系统在对源代码进行编译时会自动忽略注释的部分，因此注释对于程序的功能实现不起任何作用。在源码中适当地添加注释，能够提高源码的可读性。 Go语言的注释主要分成两类，分别是单行注释和多行注释。 单行注释简称行注释，是最常见的注释形式，可以在任何地方使用以//开头的单行注释； 多行注释简称块注释，以/*开头，并以*/结尾，且不可以嵌套使用，多行注释一般用于包的文档描述或注释成块的代码片段。 单行注释的格式如下所示 //单行注释 多行注释的格
golang坑 ‘godoc‘ 不是内部或外部命令,...
梨子社区
01-08 679
go get golang.org/x/tools/cmd/godoc
Godoc 安装与使用
sdujava2011
07-20 3343
文章目录Godoc 安装与使用前言Godoc 简介安装过程GoDoc 使用说明 Godoc 安装与使用 前言 笔者最近有一项开发程序包的任务需要完成，程序包设计好后还需要自动生成 API 文档，这就需要使用到 godoc 命令，由于生成的过程走过许多弯路，所以在此记录一下 Godoc 简介 命令 godoc 是一个很强大的工具，用于展示指定代码包的文档。如果我们的代码包在网上开源的话，别人使用我们的代码包，就可以通过查看 API 文档来快速了解代码包的使用方法。 安装过程 本人在 Windows 和 MAC
Mac下安装golang环境，安装godoc,gooracle,gocode等
Mirage520的专栏
02-26 3034
git clone https://github.com/golang/tools golang.org/x/tools 即在 GOPATH 下构建一个 golang.org/x/tools 的包，然后 go build golang.org/x/tools/cmd/godoc 这样能够编译出 godoc 二进制 可以任意目录下：git clone https://github.com/go
package golang.org/x/tools/cmd/goimports: unrecognized import path "golang.org/x/tools/cmd/goimports
Revelation_of_Turing
06-04 4473
在安装tendermint的时候，出现如下报错： package golang.org/x/tools/cmd/goimports: unrecognized import path "golang.org/x/tools/cmd/goimports" (https fetch: Get https://golang.org/x/tools/cmd/goimports?go-get=1: dial...
godoc安装与go文档查询
fenglllle的博客
11-22 741
最近在用go语言做项目，语法还是很简单的，但是API不熟悉，😅，另外也没有类似Java的Spring这样的独秀的IOC和AOP框架，灵活度很大，经常需要查询文档，但是godoc从go1.14.2开始就从内置SDK移除了。实际上godoc是一个很方便的文档查询工具，不知道为什么go sdk移除掉了，但是可以通过手动安装的方式安装，实现本地文档查看。
GOPROXY：解决 go get golang.org/x 包失败
热门推荐
琦彦
02-10 11万+
问题现象 当我们使用go get、go install、go mod等命令时，会自动下载相应的包或依赖包。但由于众所周知的原因，类似于golang.org/x/...的包会出现下载失败的情况。如下所示： package golang.org/x/tools/cmd/goimports/...: unrecognized import path "golang.org/x/tools/...
3.Go自动生成SDK实践-蒙卓1
08-04
官方简介(https://blog.golang.org/generate)Go自动生成SDK实践一些窍门巧用// +build ignoreGo自动生成SDK

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值