godoc

最新推荐文章于 2022-11-22 22:00:07 发布
最新推荐文章于 2022-11-22 22:00:07 发布
阅读量1.1k 收藏
点赞数
分类专栏： Go 文章标签： go 注释
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u012742966/article/details/78575071
版权

go语言可以在代码的注释中进行说明，格式正确的话就会被godoc展现出来

经使用发现，代码中的注释能第一时间反应在godoc中，但是package整体的介绍却不会，需要终止godoc程序，然后在重新运行，改变才会看到

还有，最好使用英文进行说明。英文的话，如果前一行和后一行都有空格，而且本行开头首字母大写，行尾还没有标点，那就会被当成标题显示

一组前面有退格的说明会被godoc发现，并且放到灰色的框中，很好看

「已注销」
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
godoc教程learn_doc.zip
10-17
在Go语言的开发环境中，`godoc`是一个非常重要的工具，它用于生成和查看Go项目的文档。本教程将深入探讨`godoc`的使用方法，包括如何创建有效的注释、如何运行`godoc`服务器以及如何利用其进行项目文档的管理。 ...
Go语言 godoc.exe下载，查看包源码
02-16
`godoc.exe`是`godoc`工具的Windows版本，用于在本地环境下生成和展示Go语言的包文档。这个工具可以帮助开发者快速地查找和学习Go包的功能，而无需上网搜索。在收到的压缩包中，包含的`godoc.exe`文件是直接运行在...
go语言学习笔记——godoc的使用（超详细，含示例文件）
热门推荐
zhh763984017的博客
10-17 2万+
godoc使用教程 注释规范 注释符//后面要加空格, 例如: // xxx 在注释符要缩进的话，第二行注释符后面的空格要比上一行的空格多一个 example: // 123 // 123 注释要紧跟package、const、type、func这些关键字，这样子才会被显示 // 功能: 函数H的注释 // 参 数: // h1...
golang中的godoc使用简介
猛犸象
10-26 2033
golang中的godoc使用简介
Godoc 安装与使用
sdujava2011
07-20 3342
文章目录Godoc 安装与使用前言Godoc 简介安装过程GoDoc 使用说明 Godoc 安装与使用 前言 笔者最近有一项开发程序包的任务需要完成，程序包设计好后还需要自动生成 API 文档，这就需要使用到 godoc 命令，由于生成的过程走过许多弯路，所以在此记录一下 Godoc 简介 命令 godoc 是一个很强大的工具，用于展示指定代码包的文档。如果我们的代码包在网上开源的话，别人使用我们的代码包，就可以通过查看 API 文档来快速了解代码包的使用方法。 安装过程 本人在 Windows 和 MAC
godoc安装与go文档查询
fenglllle的博客
11-22 741
最近在用go语言做项目，语法还是很简单的，但是API不熟悉，😅，另外也没有类似Java的Spring这样的独秀的IOC和AOP框架，灵活度很大，经常需要查询文档，但是godoc从go1.14.2开始就从内置SDK移除了。实际上godoc是一个很方便的文档查询工具，不知道为什么go sdk移除掉了，但是可以通过手动安装的方式安装，实现本地文档查看。
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
godoc-docker:godoc docker 容器
06-08
godoc-docker 在 Docker 中运行。 这个容器默认运行godoc -http=:6060 。 使用以下命令运行它： docker run -v $GOPATH:/gopath --net=host -d --name=godoc -p 6060:6060 arschles/docker-godoc
goclipse godoc.exe
04-24
在本文中，我们将深入探讨如何在Windows环境下使用Eclipse集成开发环境（IDE）与GoClipse插件来高效地编写和管理Go语言代码，并利用godoc.exe工具进行文档的查看和学习。 首先，让我们理解标题中的关键词“goclipse...
转到GoDoc「Goto GoDoc」-crx插件
03-09
打开godoc.org当前选定的页面。 Goto GoDoc允许您在godoc.org中打开当前打开的Go存储库以显示其文档。 大多数Go软件包都包含文档。 如果软件包提供了公共源代码存储库，例如在GitHub，BitBucket，Launchpad，Google ...
Go基本命令及自定义第三方包、安装本地第三方包的函数文档
u011867622的专栏
07-08 524
go 命令 自定义包 文档
godoc使用详解
wzbwzh的专栏
05-24 4377
例子：我想要生成某个文件夹下的go文档，假设你的gopath是D:/code你项目目录是D:\code\src\下的test，你想生成test 项目中的testcode文件夹下的所有go的doc;那么需要执行如下步骤。 第1步、那么在命令行中进入到该文件夹下 D:\code\src\test，执行 godoc -http=:6060 第2步、打开浏览器输入http://127.0.0.1:...
godoc工具使用
elegance_zf的博客
03-14 1万+
godoc工具使用
golang注释和文档说明及go doc/godoc说明
Colinspace
12-31 2078
该篇分享主要是介绍golang中单行注释、多行注释的使用场景和文档描述配置，及go doc和godoc的用法
godoc使用方法介绍
weixin_42898443的博客
10-22 1127
一、go doc简介 Godoc是go语言的文档化工具，类似于文档化工具godoc，类似于Python的Docstring和Java的Javadoc Godoc通过解析包含注释的Go代码来生成HTML或文本类型的文档。 二、约定规则 godoc Go的注释规则很简单，为类型，变量，常量，函数或包编写注释时，直接在这些声明前编写普通形式的注释，中间不留空行即可。Godoc将这些注释与后面的声明连接到...
本地搭建godoc服务器
gx_1983的专栏
07-28 2127
本地搭建godoc服务器 在实际工作中，经常需要查go相关的语法及go的标准库。 在本地搭建一个godoc环境往往更为方便，也避免了有时不能访问网络的问题。 搭建方法很简单： 1. 在windows上安装go语言开发环境并正确配置。 2. 在控制台执行 godoc -http=:8080 3. 在浏览器中访问 http://127.0.0.1:8080 (注意不是http...
godoc 的安装使用
liukai6的博客
11-07 2995
安装 go get -v golang.org/x/tools/cmd/godoc 常见的使用技巧 # 查看包内的文档，这里是查看 fmt 包中Println 的的文档 godoc fmt Println # 查看文档并包含源码 godoc -src fmt Printf # 显示文档的web版本 http -> 端口 godoc -http=:6060 # 显示 http 文档并开启本地索引 godoc -http=:6060 -index ...
go doc 命令介绍
RenXiang_Code的博客
02-19 5412
一：go doc 命令介绍 作用：打印出程序实体说明文档。后可不跟参数或一个参数或两个参数 格式：go doc 标记 参数 标记和参数可以不填， go doc 在 main 包下，执行 go doc 默认是不打印的，除非加上 -cmd 标记，后面会讲 在非 main 包下，执行 go doc 打印当前代码包文档及其程序实体列表（程序实体：变量、常量、函数、结构体以及接口） go ...
godoc安装与自动生成API文档
STcyclone的博客
01-08 614
先使用命令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:60
zsh: command not found: godoc
最新发布
07-02
"zsh: command not found: godoc" 这是一个终端提示，表示你在Zsh（Z Shell）环境中尝试运行名为 "godoc" 的命令时找不到。Godoc 是 Go 语言的一个文档生成工具，用于查看 Go 语言程序包的文档。如果你遇到这个错误...

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值