Android Studio 中的 Javadoc @link 引用到 build.gradle

Posted 2023-02-21

【中文标题】Android Studio 中的 Javadoc @link 引用到 build.gradle

【英文标题】：Javadoc @link references in Android Studio to build.gradle

【发布时间】：2018-09-04 03:40:56

【问题描述】：

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

我知道如何在 android Studio 中执行 Javadoc cmets。我可以像这样使用@link 链接java文件：

@link FileName#methodName() some text to display

但我无法找到在 cmets 中链接 build.gradle 文件的方法。我需要这个的原因是我们将buildConfigField 存储在 Gradle 文件中，如下所示：

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

我在评论该文件时，确保每次在文件中发生更改时都升级此版本号。在文件上写下 java cmets 时，我遇到了这种情况。有没有办法链接文件？

【问题讨论】：

您是否尝试在@link 中提供绝对路径？

你能告诉我怎么做吗？因为它不在任何包装内。

使用 html 链接。

我将如何做到这一点？任何示例都会有所帮助。

【参考方案1】：

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

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

Oracle 描述关于在 Javadoc 中包含文件的说明：

其他未处理的文件

您还可以在源中包含您希望 Javadoc 工具复制到目标目录的任何其他文件。这些通常包括图形文件、示例 Java 源 (.java) 和类 (.class) 文件，以及其内容会淹没普通 Java 源文件的文档注释的独立 HTML 文件。 要包含未处理的文件，请将它们放在名为 doc-files 的目录中，该目录可以是包含源文件的任何包目录的子目录。每个包都可以有一个这样的子目录。您可能包括图像、示例代码、源文件、.class 文件、小程序和 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 文档注释中的链接可能如下所示：

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

【讨论】：

我做了什么<a href="/Users/sierra1/Desktop/project/Mermaids/app/build.gradle">build.gradle</a>。它开始将其显示为链接，但无法解析 URL。？我做错了什么？

您的链接找不到该文件。使用此链接。 build.gradle

我还是不知道。如何链接build.gradle 文件，因为我无法按照您发布的文档中的建议将该文件放入任何其他包中。

无法解析 URL ../Users/sierra1/Desktop/project/Mermaids/app/build.gradle 在项目设置中配置 API 文档的路径可能会有所帮助

在项目设置中添加build.gradle的引用。检查这个：***.com/questions/17912527/…