☰ 菜单
首页›命令行工具›protoc-gen-doc
命令行 开源 18 次安装/月

protoc-gen-doc for Mac 版

protoc-gen-doc

用于 Google 协议缓冲的文档生成器插件

protoc-gen-doc 是什么

protoc-gen-doc 是 Google Protocol Buffers 编译器(protoc)的文档生成插件,能够从 .proto 文件中的注释自动生成 HTML、JSON、DocBook 和 Markdown 格式的文档。它同时支持 proto2 和 proto3,也能处理同一项目中混用两种版本的情况。

这个插件解决的问题很直接:Protocol Buffers 的接口定义通常分散在多个 .proto 文件中,手工维护文档既繁琐又容易过时。protoc-gen-doc 让文档随代码走,注释写在哪里,文档就生成到哪里,省去了额外维护一套文档的成本。

使用方式上,它通过 protoc 的 --doc_out 和 --doc_opt 选项调用,输出格式可以是内置的几种,也可以指定自定义 Go 模板文件。插件提供了 Docker 镜像,挂载 /out 和 /protos 两个目录即可使用,也支持通过 go get 本地安装或从 releases 页面下载预编译版本,Maven Central 上同样可以获取。

它适合使用 Protocol Buffers 定义接口的团队,尤其是需要为 API 提供可读文档、又不想脱离 .proto 源文件单独维护文档的开发者。

如何安装 protoc-gen-doc

  1. 打开 终端(按 ⌘ + 空格,输入“终端”)。
  2. 如果还没安装 Homebrew,先运行下面这条安装命令。
  3. 运行下面这条命令:

最近 10 个版本记录

最近一次更新为 2022-02-18,当前版本 v1.5.1,共记录最近 10 个版本。

版本发布日期类型大小macOSWindowsLinux
v1.5.12022-02-18稳定版2.9 MB下载下载下载
v1.5.02021-08-11稳定版2.9 MB下载下载下载
v1.4.12021-01-25稳定版3.1 MB下载下载下载
v1.4.02021-01-22稳定版3.1 MB下载下载下载
v1.3.22020-05-07稳定版3.7 MB下载下载下载
v1.3.12020-03-03稳定版3.7 MB下载下载下载
v1.3.02019-04-15稳定版3.4 MB下载下载下载
v1.2.02019-03-13稳定版2.2 MB下载下载下载
v1.1.02018-03-13稳定版1.2 MB下载下载下载
v1.0.02017-09-27稳定版1.2 MB下载下载下载

数据来自 GitHub Releases,稳定版优先,同类按发布时间排序。

二进制包支持平台

Homebrew 官方提供的预编译包(bottle)覆盖:

  • Apple 芯片 · 最新 macOS
  • Apple 芯片 · macOS 26 Tahoe
  • Apple 芯片 · macOS 15 Sequoia
  • Apple 芯片 · macOS 14 Sonoma
  • Intel · macOS 14 Sonoma
  • Linux · ARM64
  • Linux · x86_64

与同类应用对比

只对比公开元数据,不做主观推荐;需要逐项对比时见对比页。

与同类应用对比
应用版本许可证架构近 30 天安装
protoc-gen-docv1.5.1MIT命令行18
protoc-gen-jsv4.0.3BSD-3-Clause命令行54
stuntman1.2.16Apache-2.0命令行20
cloudflare-quiche0.30.1BSD-2-Clause命令行20

命令行工具中的类似应用

发表评论

电子邮件地址不会被公开。必填项已用 * 标注。