文档生成

protoc-gen-doc

https://github.com/estan/protoc-gen-doc

这是一个Google Protocol Buffers编译器(protoc)的文档生成插件。这个插件可以从.proto文件中的注释内容生成HTML, DocBook 或者 Markdown 文档。

安装

参考 protoc-gen-doc Installation章节的信息。

linux安装

对于ubuntu系统,参考 protoc-gen-doc的说明。

对于 xUbuntu 14.04,请运行以下命令:

  1. sudo sh -c "echo 'deb http://download.opensuse.org/repositories/home:/estan:/protoc-gen-doc/xUbuntu_14.04/ /' >> /etc/apt/sources.list.d/protoc-gen-doc.list"
  2. sudo apt-get update
  3. sudo apt-get install protoc-gen-doc

windows

protoc-gen-doc的github项目的 release page上 ,可以找到windows的版本的下载。

执行

  1. cd dolphin-demo/contract
  2. protoc --doc_out=html,index.html:target/contract-doc src/main/proto/*.proto

可惜,报错:

  1. src/main/proto/user.proto:1:10: Unrecognized syntax identifier "proto3". This parser only recognizes "proto2".

目前版本还不支持proto3!真是遗憾。

2016-08-07 更新: 发现上面的错误提示只是 protoc 版本的问题,只要升级 protoc 版本到v3.0.0,这个 proto-gen-doc 插件依然可以正常工作! 详细做法请见下一节 “支持proto3”.