Javadoc使用相对路径链接到src/main/resource或src/test/resource文件

Question

如果有一种方法可以在javadoc中放置指向驻留在src/main/资源或src/test/资源中的标准资源文件的链接，以便另一个编码器可以快速导航到IntelliJ中的资源文件（在这种情况下是JSON文件），我会发现它非常有用。

这些文件在单元测试中使用，需要在模式更改时经常修改。

这里的答案是Javadoc中指向文本文件（资源）的链接没有帮助，因为绝对路径太脆弱。

有没有和@用资源看一样的方法？如果javadoc本身有所欠缺的话，IntelliJ特有的东西会很好。

Answer 1

这在IntelliJ IDEA中创建了一个可点击的链接，但只能指向一个目录:-/。

src/test/resources/some/path/

/**
 * {@link some.path}
 */

如果您添加了< code>filename.ext，或者某个目录是非法的包名(例如:以数字开头)，它就不起作用。

到目前为止，这是我找到的最好的。不太好，但在我发现的测试中，仍然可以方便地提示静态文件的使用（如外部API响应），并提供指向它们位置的链接。

Answer 2

这不是一个答案，而是IDE的一个特性：

如果您使用Intellij IDEA，则可以开箱即用。加载文件的位置必须指定路径，对吗？因此，您按住 Ctrl 键单击路径，Intellij 就会将您带到该文件。

路径是相对于类路径的，因此具有可移植性。

它要求所有团队成员使用Intellij，是的，不是一个全局解决方案，不是一个“字面”解决方案。

检查这个：

Answer 3

无需提及绝对路径。见下面我的包和类结构。如果我遵循URI规则，我做一个<代码>..返回一个文件夹，并像这样提及它。有用！单击url时，文件打开。尽管我已经在eclipse中说明了这一点，但我认为这应该是IDE不可知的。

/**
 * Removes all the stop words like a, for, the etc. from the text. For a
 * full list of stop words check
 * <a href="file:../resources/stopWords.txt">/resources/stopWords.txt</a>
 * 
 * @return String free of all the stop-words
 * @param text
 *            The string to be cleaned, do null check at your end
 */