环境说明
- 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 文件示例
/**
* @desc 登录服务器回包 20001
* @copyright :copyright:2018 nbob
* @release Monday, September 24, 2018
* @author BobWong
*/
syntax = "proto3";
package protobuf;
message LoginServerBackItem {
string playerId = 1; // 角色id
string name = 2; // 角色名称
int64 lastLoginTime = 3; // 最后一次登录时间
}
message LoginServerBackRes {
message Data {
LoginServerBackItem player = 1; // 角色
}
int32 code = 1;
Data data = 2;
}
/**
* 被服务器踢出
*/
message KickByServer {
int32 reason = 1; // 被踢出原因
}
生成的 markdown 文档示例
- enjoy
欢迎来到这里!
我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。
注册 关于