protobuf 文档生成

环境说明

• mac osx 10.12.6
• golang 1.10.3
• protobuf 3.5.1

步骤

• 从 github 上获取工程手动编译

进入到 $GOPATH/src/github.com/pseudomuto/protoc-gen-doc/cmd 目录,执行 go build -o protoc-gen-doc -a 可以得到 protoc-gen-doc 的可以执行文件

• 集成到 protoc 的插件里面

protoc --plugin=protoc-gen-doc=./proto-gen-doc  --doc_opt=markdown,protocol.md  --doc_out=./doc  ./*.proto

proto 文件示例

生成的 markdown 文档示例


enjoy