使用工具生成 Protocol 易讀文件

前言

透過 .proto 檔案能否生成更易閱讀 HTML 文件？

關於這個問題，我找到了一個外掛，給大家分享一下。

protoc-gen-doc

protoc-gen-doc This is a documentation generator plugin for the Google Protocol Buffers compiler (protoc). The plugin can generate HTML, JSON, DocBook and Markdown documentation from comments in your .proto files.

安裝

go get -u github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc

使用

--doc_out=helloworld/doc \
--doc_opt=html,index.html

演示

以上篇文章 helloworld.proto 為例。

// 使用的 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 文件，去試試吧。

小結

以上，希望對你能夠有所幫助。

你用過哪些好用的 protoc 外掛？歡迎留言評論 ~

推薦閱讀

• Go - 如何編寫 ProtoBuf 外掛 (三) ？
• Go - 如何編寫 ProtoBuf 外掛 (二) ？
• Go - 如何編寫 ProtoBuf 外掛 (一) ？
• Go - 關於 protoc 工具的小疑惑
• Go - 關於 .proto 檔案的小思考

本作品採用《CC 協議》，轉載必須註明作者和本文連結