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

Question

如果有一种方法可以将javadoc中的链接放入驻留在src/main/resources或src/test/resources中的标准资源文件,以便另一个编码器可以快速导航到资源文件,我会觉得非常有用(在此case一个JSON文件).

这些文件用于单元测试,需要在架构更改时经常进行修改.

这里的答案链接到Javadoc中的文本文件(资源)没有帮助,因为绝对路径太脆弱了.

有没有办法像资源一样做@see？如果javadoc本身不足,那么IntelliJ特有的东西会很棒.

Answer 1

无需提及绝对路径。请参阅下面我的包和类结构。从姊妹包中，如果我遵循 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
 */

Answer 2

不完全是答案，而是 IDE 的一个功能：

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

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

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

检查一下：