文件名称：protoc-gen-doc:Google协议缓冲区的文档生成器插件
文件大小：110KB
文件格式：ZIP
更新时间：2024-05-02 10:51:44
protobuf documentation-tool protoc Go
原始文件
这是Google协议缓冲区编译器（ protoc ）的文档生成器插件。 该插件可以从.proto文件中的注释生成HTML，JSON，DocBook和Markdown文档。
它支持proto2和proto3，并且可以在相同的上下文中处理这两个问题（有关，请参见）。
安装
有一个可用的Docker映像（ docker pull pseudomuto/protoc-gen-doc ），其中包含从protos生成文档所需的一切。
如果您想在本地安装它，则go get它。
go get -u github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc
调用插件
通过将--doc_out和--doc_opt选项传递给protoc编译器来调用该插件。 该选项具有以下格式：
--doc_opt=
【文件预览】：
protoc-gen-doc-master
----Dockerfile(629B)
----.gitignore(84B)
----revive.toml(1KB)
----plugin.go(4KB)
----README.md(7KB)
----plugin_test.go(3KB)
----CHANGELOG.md(6KB)
----resources()
--------docbook.tmpl(7KB)
--------main.go(2KB)
--------markdown.tmpl(3KB)
--------scalars.json(4KB)
--------html.tmpl(12KB)
----extensions()
--------extensions.go(1KB)
--------validator_field()
--------google_api_http()
--------envoyproxy_validate()
--------lyft_validate()
----doc.go(711B)
----fixtures()
--------Vehicle.proto(4KB)
--------fileset.pb(60KB)
--------generate.go(827B)
--------Booking.proto(2KB)
--------Cookie.proto(255B)
--------cookie.pb(488B)
----examples()
--------doc()
--------proto()
--------templates()
----version.go(96B)
----.dockerignore(11B)
----.gofmtignore(20B)
----bench_test.go(385B)
----go.mod(1KB)
----script()
--------push_to_docker.sh(937B)
--------dist.sh(1KB)
--------entrypoint.sh(358B)
----CONTRIBUTING.md(4KB)
----thirdparty()
--------generate.go(710B)
--------github.com()
----template.go(19KB)
----template_test.go(17KB)
----filters_test.go(2KB)
----LICENSE.md(1KB)
----resources.go(7KB)
----filters.go(1KB)
----renderer_test.go(1KB)
----go.sum(5KB)
----.travis.yml(1KB)
----Makefile(3KB)
----renderer.go(4KB)
----cmd()
--------protoc-gen-doc()