当前位置： 首页 > news >正文

非零基础自学Golang 第15章 Go命令行工具 15.4 注释文档(doc)

news 来源：原创 2024/9/23 22:29:11

非零基础自学Golang

文章目录

      • 非零基础自学Golang
      • 第15章 Go命令行工具
        • 15.4 注释文档(doc)

第15章 Go命令行工具

15.4 注释文档(doc)

Go语言文档工具go doc和go fmt一样，也是对godoc的简单封装。

我们通常使用go doc查看指定包的文档。

在这里插入图片描述

例如我们查看函数fmt.Println的文档说明：

C:\Users\admin>go doc fmt.Println

在这里插入图片描述

Go语言文档是如何写的？我们可以查看fmt.Println的源码文件：

// Println formats using the default formats for its operands and writes to standard output.
// Spaces are always added between operands and a newline is appended.
// It returns the number of bytes written and any write error encountered.
func Println(a ...any) (n int, err error) {
   return Fprintln(os.Stdout, a...)
}

在这里插入图片描述

由此可以看出，Go语言的文档只需要在每个函数上方用注释的方式介绍该函数的作用及使用方法，go fmt命令就会自动将这些注释转化为文档展示出来。

gofmt命令有一个非常重要的参数-http，这个参数的作用是开启Web服务，提供交互式的文档查看页面。

godoc -http :8080

这里要用到 一个叫godoc 的工具，但是默认

在这里插入图片描述

是没有的

'godoc' 不是内部或外部命令，也不是可运行的程序或批处理文件。

这里笔者自己捣鼓了一种解决办法，

先下载 go 工具包的源码

https://github.com/golang/tools

如果是 那啥都不好使的，克都克隆 不下来的

直接进 GitHub 把源码下载下来

在这里插入图片描述

直接下载压缩包

在这里插入图片描述

直接解压

在这里插入图片描述

进到里面

在这里插入图片描述

在这儿，打开cmd

在这里插入图片描述

没毛病就OK 了

在这里插入图片描述

而且在我们 的GOPATH 下生成了一个 可执行文件

这下就可以 查看帮助了

在这里插入图片描述

再试一次

在这里插入图片描述

浏览器访问

在这里插入图片描述

牛逼，这样即可通过网页的方式查看Go语言文档了

相关文章：

  • 服务器IPMI（BMC）装机
  • 转行IT，女生学编程有前途吗？
  • KG-构建：知识图谱基础代码构建（医疗向）
  • 【Numpy基础知识】Broadcasting广播
  • 华为云CDN助力企业用户体验全面优化，让企业“惠”加速
  • Java项目：springboot+vue电影院会员管理系统
  • Android实现一维二维码扫描生成功能(一)-zxing导入现有项目
  • 企业经常会问到的软件测试面试题及答案，一定要好好记住
  • 转互联网好难，如何避免无效转行？
  • 试卷的安全方案
  • 真香啊，这招可以轻松抓取某音短视频数据(附 Python 代码）
  • ETHERCAT从站设计与FOC伺服马达电流环控制
  • nginx 解决跨域问题——（CORS）
  • Freemodbus启动流程分析
  • Java项目：springboot网上点餐系统
  • 全国职业院校技能大赛中职组网络安全竞赛试题 —XSS漏洞（笔记文档）
  • 4、常用类和对象
  • 机器学习模型-BUPA liver disorders-探索饮酒与肝炎关系
  • 【架构师（第五十三篇）】 性能优化之 HTTP 缓存
  • 博德宝闪耀回归，九牧国际化提速