为 Bazel 创建 javadoc 规则

一则或许对你有用的小广告

欢迎加入小哈的星球 ,你将获得:专属的项目实战 / Java 学习路线 / 一对一提问 / 学习打卡/ 赠书活动

目前,正在 星球 内带小伙伴们做第一个项目:全栈前后端分离博客项目,采用技术栈 Spring Boot + Mybatis Plus + Vue 3.x + Vite 4手把手,前端 + 后端全栈开发,从 0 到 1 讲解每个功能点开发步骤,1v1 答疑,陪伴式直到项目上线,目前已更新了 204 小节,累计 32w+ 字,讲解图:1416 张,还在持续爆肝中,后续还会上新更多项目,目标是将 Java 领域典型的项目都整上,如秒杀系统、在线商城、IM 即时通讯、权限管理等等,已有 870+ 小伙伴加入,欢迎点击围观

一些用户询问了如何使用 Bazel 生成 javadoc。没有内置的方法,但我认为将新规则组合在一起可能会很有用。

这里是。

如果您想使用此规则,请将其下载到您的工作区,将其加载到您的构建文件中,并为其提供源列表:


 load("/javadoc", "javadoc")

javadoc( name = "app-doc", srcs = glob(["**/*.java"]), )

然后构建:


 load("/javadoc", "javadoc")

javadoc( name = "app-doc", srcs = glob(["**/*.java"]), )

现在,如果您查看 bazel-bin/app-doc.zip ,您可以看到它包含由 javadoc 生成的 HTML 树:


 load("/javadoc", "javadoc")

javadoc( name = "app-doc", srcs = glob(["**/*.java"]), )

然后,您可以将其解压缩到您想要查看文档的任何位置。

请注意,这是一个极其有限的实现:我只是在 20 分钟内完成了它。它不支持任何 javadoc 选项,并且可能无法正确处理依赖项。让我知道您是否有任何问题,我可以根据需要实施改进。

此条目发布于 2015 年 9 月 28 日星期一下午 12:24,并归档在 Bazel 下。您可以跳到最后并留下回复。目前不允许 Ping。