首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

如何使用“godoc”显示“包内调用图”

godoc是Go语言自带的文档工具,用于生成和查看Go代码的文档。它可以根据代码中的注释自动生成文档,并提供了一个Web界面来浏览这些文档。

要使用godoc显示包内调用图,可以按照以下步骤进行操作:

  1. 确保已经安装了Go语言的开发环境,并且已经配置好了GOPATH和PATH环境变量。
  2. 打开终端或命令提示符,进入到你的Go项目的根目录。
  3. 运行以下命令来生成文档:
  4. 运行以下命令来生成文档:
  5. 这将启动一个本地的Web服务器,并将文档生成在默认的6060端口上。
  6. 打开浏览器,访问以下地址:
  7. 打开浏览器,访问以下地址:
  8. 这将打开godoc的Web界面,显示你的项目的文档。
  9. 在搜索框中输入你想要查看的包名,然后点击搜索按钮。
  10. 在搜索结果中找到你想要查看的包,点击它的链接。
  11. 在包的文档页面中,你可以看到包的详细信息和导出的函数、类型等。
  12. 要查看包内调用图,点击页面左侧的"Package files"链接。
  13. 在"Package files"页面中,你可以看到包内所有文件的列表。
  14. 点击文件名,然后在文件的文档页面中,你可以看到该文件的调用图。

通过以上步骤,你可以使用godoc显示包内调用图。这对于理解代码的结构和依赖关系非常有帮助,特别是在大型项目中。在腾讯云的产品中,与Go语言相关的产品有云函数SCF(https://cloud.tencent.com/product/scf)和容器服务TKE(https://cloud.tencent.com/product/tke),它们可以帮助你更好地部署和管理Go语言的应用。

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

作为Gopher,你知道Go的注释即文档应该怎么写吗?

目前的godoc和pkgsite有两个作用,一个是用来本地调试自己的GoDoc显示效果;另一个是在无法科学上网的时候,用来本地搭建GoDoc服务器之用。 二、godoc命令 我们从工具命令开始讲起吧。...在2019年之前,Go使用的是godoc这个工具来格式化和展示Go代码中自带的文档。...Go秉承“注释即文档”的理念,其中pkg.go.dev、godoc和pkgsite都使用同一套GoDoc格式,三者都按照该格式从文档的注释中提取,并生成文档。...如果要在同一个注释块中新加一个段落,那么我们需要插入一行空注释,如下: // SomeNewLine 只是用来展示如何GoDoc 中换行。...标准输出内容在函数的最后,采用//Output: 单独起一行开头,剩下的每一行标准输出写一行注释。

1.1K20

作为 Gopher,你知道 Go 的注释即文档应该怎么写吗?

,一个是用来本地调试自己的 GoDoc 显示效果;另一个是在无法科学上网的时候,用来本地搭建 GoDoc 服务器之用。...---- godoc 命令   我们从工具命令开始讲起吧。在 2019 年之前,Go 使用的是 godoc 这个工具来格式化和展示 Go 代码中自带的文档。...如果要在同一个注释块中新加一个段落,那么我们需要插入一行空注释,如下: // SomeNewLine 只是用来展示如何GoDoc 中换行。...标准输出内容在函数的最后,采用 // Output: 单独起一行开头,剩下的每一行标准输出写一行注释。...另:本文部分内容与笔者以前发布过的《如何写高大上的 godoc》一文类似,但当时成文与还没有 pkg.go.dev 的时代,很多内容已经落伍。因此我重新写了这篇。 [1620]

4.4K81
  • Golang之go 命令用法

    1.3 Go命令显示详细的信息 这些命令对于我们平时编写的代码非常有用,接下来就让我们了解一些常用的命令。 go build 这个命令主要用于编译代码。...使用go fmt命令,其实是调用了gofmt,而且需要参数-w,否则格式化结果不会写入文件。gofmt -w -l src,可以格式化整个项目。...-t 同时也下载需要为运行测试所需要的 -u 强制使用网络去更新和它的依赖 -v 显示执行的命令 go install 这个命令在内部实际上分成了两步操作:第一步是生成结果文件(可执行文件或者....如何查看相应package的文档呢?...例如builtin,那么执行godoc builtin 如果是http,那么执行godoc net/http 查看某一个里面的函数,那么执行godoc fmt Printf 也可以查看相应的代码,

    5.2K20

    2011年03月31日 Go生态洞察:Godoc —— Go代码的文档化

    今天,作为猫头虎博主,我要引领大家探索Go语言的神器——Godoc。 深入这篇文章,你将发现如何使用Godoc来维护和美化你的Go代码,使其通俗易懂,维护性更佳。...这些注释将会和它们所描述的项目并列显示。 注释规范与样例 类型、变量和函数注释:注释应该是完整的句子,以元素的名称开始。 注释:提供的概述,应在声明之前直接注释,无空行。...遗留代码与弃用警告 当一个结构体字段、函数、类型或整个变得多余或不必要时,为了保持向后兼容性,需要保留它们。在文档注释中添加“Deprecated:”段落,以指示不应再使用该标识符。...package sort 使用Godoc的优势 Godoc的最大优势在于它的简约。遵循上述的注释约定,你的Go代码就可以呈现出良好的文档。...任何安装在$GOROOT/src/pkg的Go以及GOPATH工作空间中的代码都可以通过Godoc的命令行和HTTP接口访问。 总结 Godoc工具展示了Go语言对文档化的重视。

    8410

    如何写高大上的 godoc(Go 文档)

    如果需要换行,则留一行空注释 如果找到多个符合条件的注释,则按照文件字母序显示——建议把 Overview 放在一个注释块中,而不要分散撰写。...于是我们在 godoc 网页上,就可以看到这样的显示结果了: [mdvrd36bxk.png] godoc 的代码文档 godoc 工具会搜寻代码中所有源码文件(自测文件除外),然后展示到页面上。...这个文件的 package 名也不得与当前名相同,而应该命名为 名_test 的格式。 示例代码的声明 如何声明一个示例代码,这里我举两个例子。...标准输出内容在函数的最后,采用 // Output: 单独起一行开头,剩下的每一行标准输出写一行注释。...[6kdd2fbcv4.png] --- 本文章采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可。 原作者: amc,欢迎转载,但请注明出处。

    10.7K150

    Go 常用命令介绍

    go fix 更新使用新的API。 go fmt 使用gofmt重新格式化Go的源代码。 go generate 通过处理源代码来生成Go文件。...中引入的 -x 打印出来执行的详细命令,显示 go clean 执行的每个步骤。...-t 同时也下载需要为运行测试所需要的 -u 强制使用网络去更新和它的依赖 -v 显示执行的命令 看一个实际的例子: 在本地通过源码安装 Go 的调试器 Delve,可以这么做: go get...-v:显示执行的命令。 -x:打印执行的命令及其参数。 -work:打印临时工作目录的名称,然后退出。 -pcgo:针对cgo enabled的,调用gcc来编译。...例如builtin,那么执行godoc builtin 如果是http,那么执行godoc net/http 查看某一个里面的函数,那么执行godoc fmt Printf 也可以查看相应的代码,

    47620

    一文掌握 godoc使用与规范

    Godoc使用注释的文本来形成的文档(粒度是某个package,而不是具体到某个.go文件) 官方介绍 Godoc: documenting Go code Go 1.5之前godoc也是一个内置的命令...---- godoc个人项目 godoc默认展示的是官方标准库的内容,个人项目如何使用godoc生成文档?...可根据godoc的解析,一一与项目中的注释写法做对照 如何写高大上的 godoc(Go 文档) ---- 注释的写法与godoc的解析 关于注释的写法及在godoc解析后的样式,可参考官方文档 Go Doc...这种方式经常出现在开源项目中 ---- 发布到pkg.go.dev 参考 如何"优雅"地发布 go module 模块, 直接搜索gitlab.com/cuishuang/godoc-demo 会找不到结果...名称) 故而在本地模拟其他用户下一个这个 之后可以搜到,但会看到Redistributable license的报错,内容显示不全 需要为项目添加开源许可,push之后稍等几分钟,就能看到完整信息了

    1.4K60

    使用Go语言来理解Tensorflow

    Python绑定和Python库:这个绑定是由C++实现自动生成的,这样我们可以使用Python来调用C++函数。此外,这个库将调用融合到了绑定中,以便定义更高级别的API。 Java绑定。...因此,当我们使用任何一个API时,我们真正做的是描述一个:当我们把放到Session中并显式地在Session中运行时,的计算就开始了。...中所有方法的列表。 我们可以看到,这两个包包含了我们需要定义和计算图形的所有内容。 前者包含了构建一个基本的“空”结构(就像Graph本身)的功能,后者是包含由C++实现自动生成绑定的最重要的。...我假设读者已经熟悉了tensorflow定义的基本思想,并且知道占位符是什么以及它们如何工作。下面的代码是对Tensorflow Python绑定的第一次尝试。...作用域是我们从的根到达节点的路径。有两种定义节点的方法:在不同的作用域(Go语言)中定义操作或更改操作名称。 我们解决了重复节点名称的问题,但另一个问题显示在我们的终端上。 ?

    1.5K100

    Golang实用进阶工具

    和go-callvis:极其好用的Go程序调用生成工具[5]类似 godepgraph -h go get github.com/kisielk/godepgraph Usage of godepgraph...="_blank"]; } 配合dot命令生成调用关系 ➘ dot命令[6]是graphviz的一部分,通过编写一些类似脚本的语言,可以容易地生成流程, 格式:dot -T-o<infile.dot...gocode) 快速提示信息(使用godef) 跳转到定义(使用godef) 搜索参考引用(使用go-find-references) 文件大纲(使用go-outline) 重命名(使用gorename...golang.org/x/tools/cmd/guru [4] godepgraph: github.com/kisielk/godepgraph [5] go-callvis:极其好用的Go程序调用生成工具...: https://dashen.tech/2016/04/15/go-callvis-极其好用的Go程序调用生成工具/#go-list [6] dot命令: https://blog.csdn.net

    38220

    实效go编程--1

    示例 Go的源码不仅是核心库,同时也是学习如何使用Go语言的示例源码。...生成的输出甚至可能无法以等宽字体显示, 因此不要依赖于空格对齐,godoc 会像 gofmt 那样处理好这一切。...注释是不会被解析的纯文本,因此像HTML或其它类似于 _这样_ 的东西将按照 原样 输出,因此不应使用它们。godoc 所做的调整, 就是将已缩进的文本以等宽字体显示,来适应对应的程序片段。...名就是导入时所需的唯一默认名称, 它并不需要在所有源码中保持唯一,即便在少数发生冲突的情况下, 也可为导入的选择一个别名来局部使用。 无论如何,通过文件名来判定使用,都是不会产生混淆的。...也就是说,调用 f.Stat 使用的是前面已经声明的 err,它只是被重新赋值了而已。

    1.1K90

    Go 概念及其机制详解&内置工具使用简介 【Go语言圣经笔记】

    在本章,我们将演示如何使用已有的和创建新的。 Go还自带了工具箱,里面有很多用来简化工作区和包管理的小工具。...每个命名空间关联到一个特定的,再加上我们给类型、函数等选择简洁明了的名称,这样可以在使用它们的时候减少和其它部分名称的冲突。 每个还通过控制名称的可见性和是否导出来实现封装特性。...首先,让我们看看如何使用该特性,然后再看看它是如何工作的。...笔者总结如下: 如何命名: 一般要用短小的名,但也不能太短导致难以理解 尽可能让命名有描述性且无歧义 名一般采用单数的形式,采用复数形式时,是为了避免和同名关键字冲突 要避免名有其它的含义 如何命名成员...第二个工具,名字也叫godoc,它提供可以相互交叉引用的HTML页面,但是包含和go doc命令相同以及更多的信息。10.1演示了time的文档,11.6节将看到godoc演示可以交互的示例程序。

    1.6K30

    Go语言圣经-WEB服务与习题

    goroutine,这样服务器就可以同一时间处理多个请求 6.解决并发引起的严重bug:竞态条件,使用了mu.Lock()和mu.Unlock() 7.把请求的http头和请求的form数据都打印出来,...字符串转换为数字可以调用strconv.Atoi函数。你可以在godoc里查看strconv.Atoi的详细说明。...解答: 1.引入两个,log,net/http 2.安装godoc , apt install golang-golang-x-tools , 查找某个函数用法godoc strconv 3....multiple-value strconv.Atoi() in single-value context ,不需要的参数要用_接收 4.Lissajour服务里面的cycles参数要是float64类型,使用...cycles,_ := strconv.ParseFloat(v[0],64)函数转换 5.不能有任何输出语句,否则会弹出下载框 6.传参不能太大,要进行一下判断,否则CPU占满 效果: ?

    70430

    Go语言中常见100问题-#3 Misusing init functions

    下面的示例将定义两个:main和redis,main调用redis。...一个中可以定义多个init函数,在这种情况下,的init函数的执行顺序是基于源文件的字母顺序。...问题1:处理init函数中的错误会受到限制,因为init函数并不返回任何错误,所以当出现错误的时候调用Panic,这会导致程序挂掉。在上面的示例程序中,如果打开数据库失败,无论如何都可以停止程序。...但是,不一定由本身来决定是否停止程序,也许调用者可能更喜欢使用重试或回退机制。在init函数中执行打开数据库操作会阻止调用的客户端实现它们的错误处理逻辑。...将错误处理的责任抛给调用者;可以创建一个集成测试来检查此功能是否有效;将连接池封装在函数,而不是赋值给全局变量。 上面举了一个使用init函数的例子,以及使用init存在诸多问题。

    37910

    2012年08月16日 Go生态洞察:优雅的代码组织之道

    不仅影响你对代码的思考,还关系到如何与其他开发者沟通。让我们来看看如何选择好的名和导出标识符,以及这对于编写可维护代码的重要性。 命名的艺术 选择一个好的名是一门艺术。...选择一个好的导入路径 导入路径对于Go的用户来说就像是地址。它告诉用户从哪里可以找到的源代码。一个好的导入路径应该是全球唯一的,因此通常使用源代码仓库的路径作为基础。...内应该放什么 决定将什么放入一个需要平衡。避免将太多功能堆砌在一个,同时也不要过度拆分小包,以免陷入接口设计的泥潭。 标准库的指导 看看Go的标准库,有的很大,有的很小。...Retrieved from https://go.dev/pkg/ Godoc: documenting Go code....Retrieved from https://go.dev/doc/articles/godoc_documenting_go_code.html

    9810

    2020年12月15日 Go生态洞察:重定向godoc.org请求到pkg.go.dev

    近期,Go社区对其和模块文档服务进行了一次重要迁移。现在,godoc.org的请求将被重定向到pkg.go.dev。如果你是Go语言爱好者,这肯定是个不容错过的消息!让我们一起深入了解吧!...今天,我们将探讨Go社区如何通过重定向godoc.org到pkg.go.dev来提升文档服务。 正文内容 Go模块和生态系统的增长 Go语言自引入模块机制以来,其生态系统得到了快速发展。...这不仅是一个文档服务站点,还支持模块,提供了更好的搜索功能,以及帮助Go用户找到合适的信号指标。...gddo仓库将保持开放,供任何人使用或改进。我们将其标记为存档,表示不再接受贡献。但你仍可以继续fork仓库。 api.godoc.org会继续工作吗?...此过渡对api.godoc.org没有影响。在pkg.go.dev的API可用之前,api.godoc.org将继续服务。

    11410

    【转】Go语言Http Server源码阅读

    前言 使用Go搭建Web服务器的有很多,大致有下面几种方法,直接使用net使用net.http使用第三方(比如gorilla)。...使用net就需要从tcp层开始封装,耗费人力物力极大,果断舍弃。直接使用封装好的net.http和第三方才是上策。这里我们就选择了使用官方提供的net.http来搭建web服务。...另外附带一句,gorilla的第三方现在使用还是非常广的,文档也是比较全的,有兴趣的同学可以考虑使用一下。...} 复制代码 response 实现这三个接口的结构是response(这个结构是http私有的,在文档中并没有显示,需要去看源码) // response包含了所有server端的http返回信息...个人感觉由于go中文档较少,像这样有点复杂的,看godoc的效果就远不如直接看代码来的快和清晰了。实际上在理解了http后,才会对godoc中出现的句子有所理解。

    89540
    领券