[英]Maven JavaDoc Plugin outputs incorrect parameter alignment
我们正在使用 Maven JavaDoc 插件为我们的项目生成 javadocs。
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.2.0</version>
<executions>
<execution>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
在为某些方法生成 JavaDoc 时,alignment 完全关闭。 例如这个
@GetMapping(value = "/api/manyToOnes/{tablePlural}/{id}", produces = MediaType.APPLICATION_JSON_VALUE)
public Map<String, String> getManyToOnes(@PathVariable String tablePlural, @PathVariable Integer id)
产生这个(保留空间,请不要编辑它们):
@GetMapping(value="/api/manyToOnes/{tablePlural}/{id}",
produces="application/json")
public Map<String,String> getManyToOnes(@PathVariable
String tablePlural,
@PathVariable
Integer id)
正如你所看到的,阅读起来真的很烦人,我更喜欢它排成一行,或者至少如果中间没有很大的差距。
我无法弄清楚它到底在挣扎什么,但它似乎与注释有关。 其他不使用注释的方法很好。
我检查了配置以查看是否有任何与 alignment 相关的内容,但我没有看到任何内容。
我已经在使用最新版本,降级到以前的版本有帮助吗? 我不愿意手动遍历它们,尤其是当不能保证它曾经有效时。
我检查了问题跟踪器,似乎没有任何与我所看到的相匹配的东西。 如果没有人可以在这里提供帮助,那么我会在那里提出一个错误。 我不记得在任何其他项目的 JavaDocs 中看到过这一点,所以我倾向于认为这是我的问题,而不是他们的问题。
经过调查,我了解到它根本不是生成 HTML 的插件,而是将其委托给 JDK 提供的工具jdk/bin/javadoc.exe
在了解了这一点后,我尝试使用 JDK 9 而不是 8 进行构建,并且 output 更好。
@GetMapping(value="/api/manyToOnes/{tablePlural}/{id}",
produces="application/json")
public Map<String,String> getManyToOnes(@PathVariable
String tablePlural,
@PathVariable
Integer id)
我查看了Oracle 的 bug tracker for fixVersion = 9这导致了我的 bug: JDK-8062647
FWIW 我了解到 output 与 Java 12 中的这两个不同,所以它似乎经常经历变化。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.