go文档 - 腾讯云开发者社区

今天找到了GO内置的文档工具: godoc....以下是我多处借鉴后, 总结的 GO 文档书写规则. 文档经过测试, GO 的文档格式, 全局变量/常量/函数/结构体/接口/包等等, 声明格式都一样, 会读取对应内容上方紧跟着的注释内容....可以单独建一个doc.go的空文件, 专门用来写包文档....文档关键字那 GO 的注释中有没有文档用到的关键字呢? 有, 简单写几个..... godoc只会对公共内容生成文档, 私有内容不会展示. ---- GO的文档还有更多, 这里只是简单的整理一下, 对于之后写项目基本够用了, 再也不会在写 GO 文档的时候懵逼了.

1.1K4 0

Go 语言读写 Excel 文档

Excelize 是 Go 语言编写的一个用来操作 Office Excel 文档类库，基于 ECMA-376 Office OpenXML 标准。可以使用它来读取、写入 XLSX 文件。...相比较其他的开源类库，Excelize 支持写入原本带有图片(表)的文档，还支持向 Excel 中插入图片，并且在保存后不会丢失图表样式，可以应用在各种报表系统中。...项目主页 github.com/xuri/excelize 安装 go get github.com/xuri/excelize/v2 创建 XLSX package main import (...= nil { fmt.Println(err) } } 读写已有文档 package main import ( "fmt" "github.com/xuri...= nil { fmt.Println(err) } } 还有一些其他功能在此就不一一列举了，请参考官方文档中的更多使用示例。

2.3K12 1

您找到你想要的搜索结果了吗？

是的

没有找到

Go语言实战笔记（三）| Go Doc 文档

在Go语言中，Go为我们提供了快速生成文档以及查看文档的工具，让我们可以很容易的编写查看文档。...Go提供了两种查看文档的方式，一种是使用go doc命令在终端查看，这种适用于使用VIM等工具在终端开发的人员，它们不用离开终端，既可以查看想查看的文档，又可以编码。...在线浏览文档 go doc终端查看的方式，虽然也很便捷，不过效率不高，并且没有查看细节以及进行跳转，为此Go为我们提供了基于浏览器使用的网页方式进行浏览API 文档，我们只用点点鼠标，就可以查看了，还可以在方法...生成自己的文档 Go文档工具，还有一个亮点，就是可以支持开发人员自己写的代码，只要开发者按照一定的规则，就可以自动生成文档了。...Go的文档工具非常强大，更多功能，我们可以使用帮助命令查看。这里再推荐一个比较不错的第三方的API文档网站，收录了包括官方在内的很多Go库，可以直接跳转，关联源代码，非常方便。

1.2K3 0

MongoDB Go Driver使用帮助文档

你将会创建一个简单的程序并且学到如何：安装MongoDB Go Driver 使用Go Driver来连接MongoDB 在Go内使用BSON对象给MongoDB发送CRUD操作你可以在github...安装MongoDB Go Driver MongoDB Go Driver有几个代码包组成，如果你正在使用go get工具，你可使用如下命令安装： go get go.mongodb.org/mongo-driver...collection.UpdateOne()函数允许你更新单一的文档，它需要一个filter文档来匹配数据库里面的文档，并且需要一个update文档来描述更新的操作。...一个游标提供一个文档流，通过它你可以遍历和解码每一个文档。一旦一个游标被消耗掉，你应该关闭游标。...MongoDB Go Driver 的文档能从GoDoc获得。你可能会对使用aggregations或者transaction特别感兴趣。

3.9K4 0

swagger (GO) API文档工具入门

swaggo swagger 安装 swag 命令 go get -u github.com/swaggo/swag/cmd/swag 编写注释服务基础信息 // @title swagger使用例子...c.JSON(http.StatusOK, res) } 生成文档 // 根目录执行 swag init 配置文档路由 import ( ......_ "go-server/docs" // 这里需要引入本地已生成文档 ginSwagger "github.com/swaggo/gin-swagger" swaggerFiles...r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler)) r.Run(":8080") } 启动服务并访问 go...run main.go // 当前文档路径: localhost:swagger/index.html API 注释定义 summary 简介 // @Summary 简介 accept

3.9K3 0

Excelize 2.3.1 发布，Go 语言 Excel 文档基础库，支持加密表格文档

excelize-1392 x570-whith-bg.png Excelize 是 Go 语言编写的用于操作 Office Excel 文档基础库，基于 ECMA-376，ISO/IEC 29500...支持 XLSX / XLSM / XLTM 等多种文档格式，高度兼容带有样式、图片 (表)、透视表、切片器等复杂组件的文档，并提供流式读写 API，用于处理包含大规模数据的工作簿。...入选 2018 开源中国码云 Gitee 最有价值开源项目 GVP，目前已成为 Go 语言最受欢迎的 Excel 文档基础库。...：支持设置数据透视表的标题、样式和透视表选项安全漏洞修复兼容性提升提升 Go 1.15 版本下的兼容性，修复 Windows 操作系统下单元测试失败的问题并修复潜在的竞态条件问题提升设置默认行高的电子表格文档与...修复添加图片设置缩放失效的问题，相关 issue #691 其他单元测试更新，文档错别字修复包含简体中文、英语、法语、俄语、日语和韩语的多国语言文档网站更新

1.3K1 1

Go调用WPS转换文档为PDF

前言 COM接口名 MS控件名 name WPS文字 KWPS.Aplication WPS的Excel KET.Application WPS的演示文档 KWPP.Application Word Word.Application...Excel Excel.Application Powerpoint Powerpoint.Application 添加依赖 go get github.com/go-ole/go-ole 代码导出...PDF package main import ( ole "github.com/go-ole/go-ole" "github.com/go-ole/go-ole/oleutil" ) func...get github.com/go-ole/go-ole go get golang.org/x/sys@v0.4.0 go get github.com/lxn/win main.go package...main import ( "fmt" "github.com/go-ole/go-ole" "github.com/go-ole/go-ole/oleutil" "os" "path/filepath

1.8K1 0

写 Go 时如何优雅地查文档

假设我们想要对字符串做 split，却忘了具体用法，下面是几种常见的查文档方法。 Google google 在设置了语言是 english 的情况下，还是挺精准的。直接定位到 Go 官方文档。...pkg.go.dev pkg.go.dev 优点是官方文档，最权威，逼格最高。缺点是要准确地记住包名+函数名。...go doc cmd 优点是直接 iTerm2 里就可以查看，缺点是需要准确地记住包名+函数名。有些大佬用 vim 写代码，在 shell 环境里直接能查文档，还是很有用的。...最近看到一篇文章[2]，就讲了如何利用 Go 标准库做出一个好用的查文档工具。原理是利用 Go 提供的包解析工具，把所有的导出类型列出来。...不知道你平时查文档时用的什么方法，欢迎留言一起讨论。

6992 0

【语言实践】Go语言文档自动化之go-swagger

so，你也会明白为啥需要文档自动化吧，毕竟除了coding，技术人员主要工作就是文档，特别是在跨团队沟通的时候，在需要把技术内容输出团队之外，或者输出自己之外的人员时候。...1. go-swagger依赖包下载 go-swagger中在github.com的仓库下的依赖包如下，主要包含可以对语法进行校验的govalidator，文档化的标准specification的go-openapi...go-swagger中在golang.org的包如下（这个可以到仓库github.com/golang）。 ?...重要包介绍 go-openapi 介绍 go-openapi仓库属于openapi的一个go语言分支源码实现，那么什么是openapi呢，其实就是OpenAPI规范，即OpenAPI Specification...这也是为什么需要文档自动化的根本原因。

3.6K2 0

如何写高大上的 godoc（Go 文档）

注：本文内容已较为过时，请读者移步笔者的新文章：《作为 Gopher，你知道 Go 的注释即文档应该怎么写吗？》...Go 文档。...在实际应用中，godoc 可能可以指以下含义： https://godoc.org 中的内容 Go 开发工具安装之后，自带的一个命令，就叫做 godoc Go 工具包的文档以及生成该文档所相关的格式我们从...前面我们说到的 godoc.org，是 Go 最为官方的文档网站。其中我们可以查阅 Go 原生 package 的文档说明。...godoc 一览 Go 秉承 “注释即文档” 的理念，符合 godoc 的文档均从 Go 代码中提取并生成。我们还是从 jsonvalue 的 godoc 来看，一个一个说明。

10.9K15 0

Go - 使用工具生成易读的 Protocol 文档

文章目录：前言 protoc-gen-doc 安装使用演示小结前言通过 .proto 文件能否生成更易阅读 HTML 文档？关于这个问题，我找到了一个插件，给大家分享一下。...// 使用的 protoc --version 为 libprotoc 3.18.1 // 使用的 protoc-gen-go --version 为 protoc-gen-go v1.27.1 //...使用的 protoc-gen-go-grpc --version 为 protoc-gen-go-grpc 1.1.0 // 使用的 protoc-gen-doc --version 为 protoc-gen-doc...version 1.5.0 // 在根目录下执行 protoc 命令 protoc \ --go_out=helloworld/gen \ --go-grpc_out=helloworld/gen \...doc_out=helloworld/doc \ --doc_opt=html,index.html \ helloworld/helloworld.proto 同理，也可生成 JSON、Markdown 文档

9903 0

Excelize 发布 2.7.1 版本，Go 语言 Excel 文档基础库

图片Excelize 是 Go 语言编写的用于操作 Office Excel 文档基础库，基于 ECMA-376，ISO/IEC 29500 国际标准。...可以使用它来读取、写入由 Excel、WPS、OpenOffice 等电子表格办公应用创建的电子表格文档。...支持 XLAM / XLSM / XLSX / XLTM / XLTX 等多种文档格式，高度兼容带有样式、图片(表)、透视表、切片器等复杂组件的文档，并提供流式读写 API，用于处理包含大规模数据的工作簿...入选 2020 Gopher China - Go 领域明星开源项目(GSP)、2018 年开源中国码云最有价值开源项目 GVP (Gitee Most Valuable Project)，2022 中国开源创新大赛优秀项目...Excelize 提供了支持 WebAssembly / Javascript 环境的 excelize-wasm NPM 包Go Modules 依赖模块更新单元测试与文档更新优化内部变量与函数命名包含简体中文

1.6K5 1

Go 语言 Excel 文档类库 excelize 发布 1.4.1 版本

Excelize 是 Go 语言编写的一个用来操作 Office Excel 文档类库，基于 ECMA-376 OOXML Spec。...issue #273 新增 GetMergeCells() 方法，支持通过给定的工作表名称获取当前工作表中全部合并单元格的坐标与值支持对页面轮廓线属性设置的支持，相关 issue #304 新增 go...#297 修复部分情况下通过索引删除工作表出现的异常问题，解决了相关 issue #308 其他对单元测试进行了重构，相关 issue #322 使用为 excelize 设计的新 Logo, 大量的文档更新

1.1K5 1

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

2011年03月31日 Go生态洞察：Godoc —— Go代码的文档化摘要喵～当我们穿梭于代码的世界中，文档就像是那指路的灯塔。...让我们一起跳进Go的文档世界，探寻代码的秘密吧！引言在软件世界中，文档的重要性不亚于代码本身。一个好的文档不仅需要准确无误，还得易于编写和维护。...正文 Godoc的工作原理 Godoc不仅解析Go源码，还包括注释，并生成HTML或纯文本文档。最终结果是与它所文档化的代码紧密结合的文档。...总结 Godoc工具展示了Go语言对文档化的重视。通过遵循简单的注释规则，我们可以为代码提供紧密耦合、易于维护的文档。本文也被收录在了猫头虎的Go生态洞察专栏，希望能启发大家编写出更好的Go文档。...Godoc: documenting Go code. Retrieved from Go Blog Go官方文档: Go Doc Comments

871 0

Go语言微服务框架 - 10.接口文档-openapiv2的在线文档方案

buf工具安装所需的工具，从v1beta升到v1 |-- gen.sh 生成代码的脚本：buf+gormer |-- go.mod...Go Module文件 |-- gormer.yaml 将gormer中的参数移动到这里 |-- main.go...最佳的使用体验，就是能将多个文档合并起来，用一个API文档统一交付。这里，我们借助goswagger工具，合并文档。...总结至此，我们实现了一个关键性的功能：代码即接口文档，保证了接口文档随着代码更新的实时性。...同时，希望大家能够认识到接口文档的价值，最好能做到接口文档即代码，也就是将相关程序的逻辑尽可能地通过接口文档表达清楚。

1.9K2 0

使用go-swagger为golang API自动生成swagger文档

google一下，还真有,那就是go-swagger项目。go-swagger众多特色功能之一就是Generate a spec from source,即通过源码生成文档，很符合我的需求。...开始之前需要安装两个工具： swagger-editor:用于编写swagger文档，UI展示，生成代码等... go-swagger:用于一键生成API文档安装swagger-editor,我这里使用.../swagger-editor 安装go-swagger,我这边使用brew安装，其他安装方式，请查看官方文档: 1brew tap go-swagger/go-swagger 2brew install...很简单吧，参照文档编写几行注释，然后一个命令生成API文档。...懒癌程序员福音~ 本文所有示例代码托管在这里, 原文地址参考： swagger官方Doc Swagger从入门到精通 go-swagger文档 go-swagger的github主页版权申明：内容来源网络

10.5K2 0

Go 标准库：官方文档与实践经验的共振

Go 语言标准库为开发者提供了一系列强大的工具和库，涵盖了许多常见的编程任务。虽然 Go 的官方文档详尽且深入，但许多开发者，包括有多年经验的专家，仍然可能在尝试理解和使用某些库时遇到挑战。...为何官方文档可能不足以解释所有情况？ 1.1 抽象与实践的差距官方文档通常提供了对库和方法的抽象解释，但可能没有充分涵盖实际使用场景。而实际使用中，可能会遇到文档未覆盖的特定问题。...1.2 缺乏上下文文档可能没有提供足够的上下文来说明某个功能如何与实际项目集成。有时候，理论知识和实际应用之间的桥梁是开发者自己的经验和创造力。 2. 为何即使有经验的开发者也会感到困惑？...他们提供了实际示例和上下文，有助于填补文档和实际应用之间的差距。总结 Go 的标准库虽然强大，但理解和有效使用它可能需要超越纯粹的文档学习。...最终，个人经验和社区的力量可能是理解和利用 Go 标准库的关键。

2453 0

Excelize发布2.0.1版本，Go语言Excel文档基础库

[Excelize Go 语言 Excel 文档类库] Excelize 是 Go 语言编写的一个用来操作 Office Excel 文档类库，基于 ECMA-376 OOXML Spec。...SetDefaultFont() 和 GetDefaultFont() 方法，支持设置工作簿默认字体，相关 issue #390 新增 SetDocProps() 和 GetDocProps() 方法，支持设置和获取文档属性...修复内部计数错误导致的部分情况下产生重复批注问题，相关 issue #373 修复部分情况下因读取内部工作表 map 错误导致读取文件失败的问题，相关 issue #404 提升了处理包含数据透视表的文档兼容性...，相关 issue #413 提升了字号与粗体样式的兼容性，相关 issue #411、#420 和 #425 优化内部重算组件以修复部分情况下在工作表中删除或插入行造成文档损坏的问题，相关 issue...#421 和 #424 修复部分情况下隐藏工作表失效的问题，相关 issue #418 修复内部主题颜色索引溢出导致部分情况下图表系列过多导致文档损坏的问题，相关 issue #422 其他完善单元测试提升覆盖度

1K6 1

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

在刚接触Go的时候，我曾一度以为，pkg.go.dev上面的文档是需要开发者上传并审核的——要不然那些文档咋都显得那么专业呢。然而当我写自己的轮子时，慢慢的我就发现并非如此。...划重点：在pkg.go.dev上的文档，都是Go自动从开源项目的工程代码中爬取、格式化后展现出来的。...Go工具包的文档以及生成该文档所相关的格式——下文以“GoDoc”指代这个含义。...在2019年之前，Go使用的是godoc这个工具来格式化和展示Go代码中自带的文档。...Go秉承“注释即文档”的理念，其中pkg.go.dev、godoc和pkgsite都使用同一套GoDoc格式，三者都按照该格式从文档的注释中提取，并生成文档。

1.1K2 0

点击加载更多

扫码

添加站长进交流群

领取专属 10元无门槛券

手把手带您无忧上云

GO 文档笔记

Go 语言读写 Excel 文档

Go语言实战笔记（三）| Go Doc 文档

MongoDB Go Driver使用帮助文档

swagger (GO) API文档工具入门

Excelize 2.3.1 发布，Go 语言 Excel 文档基础库，支持加密表格文档

Go调用WPS转换文档为PDF

写 Go 时如何优雅地查文档

【语言实践】Go语言文档自动化之go-swagger

如何写高大上的 godoc（Go 文档）

Go - 使用工具生成易读的 Protocol 文档

Excelize 发布 2.7.1 版本，Go 语言 Excel 文档基础库

Go 语言 Excel 文档类库 excelize 发布 1.4.1 版本

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

Go语言微服务框架 - 10.接口文档-openapiv2的在线文档方案

使用go-swagger为golang API自动生成swagger文档

推荐一套基于go开发的文档管理系统

Go 标准库：官方文档与实践经验的共振

Excelize发布2.0.1版本，Go语言Excel文档基础库

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

扫码

相关资讯

热门标签

活动推荐

运营活动

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐