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

2022-09-02 04:45:38

如果有一种方法可以在javadoc中放置一个链接到驻留在src/main/resources或src/test/resources中的标准资源文件,以便另一个编码人员可以快速导航到IntelliJ中的资源文件(在本例中为JSON文件),我会发现它非常有用。

这些文件在单元测试中使用,并且需要随着架构的更改而经常修改。

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

有没有办法做与@see资源相同的事情?如果javadoc本身不足,那么特定于IntelliJ的东西会很棒。


答案 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
 */

enter image description here

Package Structure


答案 2

这不是一个答案,而是IDE的一个功能:

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

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

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

检查这个:

enter image description here


推荐