使用Protobuf插件进行地图输入的文档protoc-gen-doc

时间:2018-07-16 09:22:20

标签: plugins protocol-buffers documentation documentation-generation proto3

我想为proto3文件生成一个文档。因此,我尝试使用protoc-gen-doc。我在某些消息中使用地图,但是找不到记录生成的Map Entry文档的方法。这是一个示例:

示例消息:

/**
* Test
*/
message ResponseProtobuf {
map<string, string> information = 1; //Map description
}

/** * Test */ message ResponseProtobuf { map<string, string> information = 1; //Map description }

输出文档:

ResponseProtobuf

Test descripstion
Field           Type                                Label         Description
information     ResponseProtobuf.InformationEntry   repeated      info descripton

ResponseProtobuf.InformationEntry
Field   Type    Label   Description
key     string      
value   string 

问题是,ResponseProtobuf.InformationEntry是自动生成的,我不知道如何为键和值生成文档。有没有办法将它们记录下来?或者任何人都知道另一种可能的工具吗?

0 个答案:

没有答案