返回介绍

文档生成 - 使用模板定制输出

发布于 2020-09-14 13:14:42 字数 1031 浏览 999 评论 0 收藏 0

模板使用方式

protoc-gen-doc 插件支持模板,可以通过使用不同的模板来定制输出的内容和格式,命令如下:

  1. protoc --doc_out=/usr/local/include/dolphin/api.mustache,index.html:../../../target/contract-doc userService.proto

只是简单的将原来 --doc_out=html,* 中的 html 修改为具体的模板路径。

定制模板

默认使用的模板在 protoc-gen-doc 源代码根目录下的 templates 文件夹中:

  1. $ ls
  2. docbook.mustache html.mustache markdown.mustache scalar_value_types.json

定制时,将 html.mustache 文件复制出来再修改就是,例如:

  1. sudo cp html.mustache /usr/local/include/dolphin/api.mustache

HTML模板结构

TBD

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文