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描述中关于在Javadoc中包含文件的内容：

其他未处理的文件

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

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

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

Javadoc @link在Android Studio中引用build.gradle

1 个答案:

其他未处理的文件