降价协议缓冲区代码生成器
md-protobuf的Python项目详细描述
mdprotobuf提供了一个生成器,用于从google协议缓冲区文件生成mardown documnetation文件。在
生产代码
mdprotobuf为protoc协议缓冲区编译器提供了一个插件(它与协议缓冲区一起提供)。这个插件告诉protoc生成一组mardown输出文件,其中包含来自proto文件中注释的文档。在
首先,获取md protobuf的副本:
$ git clone git@github.com:mickem/md-protobuf.git
$ cd md-protobuf
接下来,安装md protobuf:
^{pr2}$最后,启动protec并告诉它生成Md输出:
$ protoc -I/path/to/your/proto/files --md_out=/output/path file1.proto file2.proto
您只需将--mdаout添加到protoc的参数中,就可以让它生成降价输出文件。在
在幕后,protoc正在您的$路径中的某个地方寻找程序protoc gen md。如果需要,可以在安装包的lieux中修改$PATH。在
- 项目
标签: