0

我正在使用 maven 生成我的项目的 Javadoc(javadoc:javadoc目标)。我还将项目的Javadoc Location属性配置为 maven 生成 Javadoc 的文件夹。然后,我可以通过选择“在浏览器中打开附加的 Javadoc”轻松地从 Eclipse Javadoc 视图中查看类的完整 Javadoc。

但是,每次我对文档进行一些更改时,我都需要使用 maven 显式地重新创建文档,然后才能在浏览器中看到文档更新。

有没有一种方法可以指示 Eclipse 在保存文件时自动生成 Javadoc 文件?

我知道当不专注于编写文档时这可能不是一个好主意,因为它可能会减慢 Eclipse 的速度。然而,当我的主要任务是编写文档时,在这个意义上的一点自动化将不胜感激。我想正确的解决方案是通过仅更新已保存文件的文档(而不是触发整个 Javadoc 生成过程)来实现,但我不知道这样的事情是否可能。

4

1 回答 1

1

如果您使用Maven Integration for Eclipse (m2e),您可以设置插件执行过滤器,以便 m2e 知道您希望在 Eclipse 中也执行特定的插件执行。您可能希望插件在后台运行:

       <execute >
         <runOnIncremental>true</runOnIncremental>
       </execute >

这一切的另一面是,每当您保存某些内容时,它将运行您的整个 Javadoc 执行,从这个意义上说,增量是误导性的。它可能会阻塞您的 Eclipse,而不仅仅是“一点”,就像您在更新的问题中所说的那样。每一个插件执行都应该被严格审查。

真正的增量解决方案不会来自 Maven,因为它不知道只需要构建项目的一部分。相反,您需要 Eclipse 直接执行此操作。我认为 Java 编译也会发生同样的事情:它是由 Eclipse 自己逐步完成的。但是,根据 Javadoc FAQ:

A9。我可以从不同的 Javadoc 运行增量构建文档吗?

基本上没有(...)

我们将此称为增量构建,并正在考虑将其用于未来的版本。

但没有什么是不可能的:)

于 2013-10-08T15:13:13.577 回答