protoc-gen-doc for Mac 版
用于 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 源文件单独维护文档的开发者。
这个插件解决的问题很直接: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
- 打开 终端(按 ⌘ + 空格,输入“终端”)。
- 如果还没安装 Homebrew,先运行下面这条安装命令。
- 运行下面这条命令:
最近 10 个版本记录
最近一次更新为 2022-02-18,当前版本 v1.5.1,共记录最近 10 个版本。
| 版本 | 发布日期 | 类型 | 大小 | macOS | Windows | Linux |
|---|---|---|---|---|---|---|
| v1.5.1 | 2022-02-18 | 稳定版 | 2.9 MB | 下载 | 下载 | 下载 |
| v1.5.0 | 2021-08-11 | 稳定版 | 2.9 MB | 下载 | 下载 | 下载 |
| v1.4.1 | 2021-01-25 | 稳定版 | 3.1 MB | 下载 | 下载 | 下载 |
| v1.4.0 | 2021-01-22 | 稳定版 | 3.1 MB | 下载 | 下载 | 下载 |
| v1.3.2 | 2020-05-07 | 稳定版 | 3.7 MB | 下载 | 下载 | 下载 |
| v1.3.1 | 2020-03-03 | 稳定版 | 3.7 MB | 下载 | 下载 | 下载 |
| v1.3.0 | 2019-04-15 | 稳定版 | 3.4 MB | 下载 | 下载 | 下载 |
| v1.2.0 | 2019-03-13 | 稳定版 | 2.2 MB | 下载 | 下载 | 下载 |
| v1.1.0 | 2018-03-13 | 稳定版 | 1.2 MB | 下载 | 下载 | 下载 |
| v1.0.0 | 2017-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-doc | v1.5.1 | MIT | 命令行 | 18 |
| protoc-gen-js | v4.0.3 | BSD-3-Clause | 命令行 | 54 |
| stuntman | 1.2.16 | Apache-2.0 | 命令行 | 20 |
| cloudflare-quiche | 0.30.1 | BSD-2-Clause | 命令行 | 20 |
命令行工具中的类似应用
protoc-gen-js
protoc-gen-js 是 Protocol Buffers 的 JavaScript 运行时库及配套编译插件。stuntman
Stuntman 是一个实现 STUN 协议的开源命令行工具,主要用来搭建 STUN 服务器。cloudflare-quiche
quiche 是 Cloudflare 开源的 QUIC 传输协议与 HTTP/3 实现,遵循 IETF 规范。radamsa
Radamsa 是一款面向鲁棒性测试的测试用例生成器,也就是常说的模糊测试器。它从已有样本出发,自动衍生出大量变形数据,用来检验程序在异常输入下是否稳定。tinyframe
tinyframe 是一个专注于帧流协议读写的极简命令行工具。它面向需要处理这类协议数据的开发者和运维人员,帮助完成帧流数据的解析与生成,省去自行编写底层读…openssl@4
OpenSSL 是一套开源、商用级、功能完整的加密工具箱,主要服务于 TLS(早期称 SSL)、DTLS 和 QUIC 协议。所属分类:命令行工具