android-studio - Android Studio中的Javadoc @link引用以build.gradle

Question

首先，这不是一个重复的问题。这个问题的灵感来自对this post.的评论

我知道如何在Android Studio中执行Javadoc注释。而且我可以使用@link这样链接Java文件：

{@link FileName#methodName()} some text to display

但是我无法在注释中找到链接 build.gradle文件的方法。之所以需要这样，是因为我们将 buildConfigField存储在Gradle文件中，如下所示：

 buildTypes.each {
    it.buildConfigField('int', 'LANGUAGE_VERSION', "3")
}

我对文件进行评论，以确保每次文件中发生任何更改时均会升级此版本号。在文件上写下Java注释时，我遇到了这种情况。有没有办法链接文件？

Answer 1

您可以尝试使用HTML链接标记在javadoc注释中提供build.gradle的绝对路径

/**
 *  <a href="./path to build.gradle/build.gradle">Link</a>  
 */

Oracle Description关于在Javadoc中包含文件的说法：

杂项未处理的文件

您还可以在源中包括希望Javadoc工具复制到目标目录的任何其他文件。这些文件通常包括图形文件，示例Java源（.java）和类（.class）文件以及独立的HTML文件，这些文件的内容会使常规Java源文件的文档注释不堪重负。
要包括未处理的文件，请将它们放在名为doc-files的目录中，该目录可以是任何包含源文件的软件包目录的子目录。每个软件包都可以有一个这样的子目录。您可能包括图像，示例代码，源文件，.class文件，applet和HTML文件。例如，如果要将按钮button.gif的图像包含在java.awt.Button类文档中，则可以将该文件放在/ home / user / src / java / awt / doc-files /目录中。注意，doc-files目录不应位于/ home / user / src / java / doc-files，因为Java不是软件包-也就是说，它不直接包含任何源文件。

这些未处理文件的所有链接都必须经过硬编码，因为Javadoc工具不会查看这些文件-它只是将目录及其所有内容复制到目标位置。例如，Button.java文档注释中的链接可能类似​​于：

/**
 * This button looks like this:
 * <img src="doc-files/Button.gif">
 */