编译为 jar 时文档不起作用答案

【问题标题】：Documentation not working when compiled to jar编译为 jar 时文档不起作用
【发布时间】：2021-03-19 01:27:31
【问题描述】：

我正在用一些有用的类为 java 创建自己的包。在其中很多中，我添加了一些文档。在编辑源文件（我正在使用 VS Code）时它工作得很好，但是在仅引用编译的 jar 库时它不会显示。此外，当 ctrl-clicking 到一个类时，它说它无法加载源代码并且只是生成了一个模板。然而，实际代码运行良好。有人能帮我吗？我在文档中做了很多工作，如果不能使用它会很遗憾。顺便说一句：我使用了 java 项目扩展中的 jar 编译器。

【问题讨论】：

您的文档是什么意思？它是一个链接还是一段文字？您如何添加它，例如将其放入代码中或通过注释来添加？
我将文档作为源代码中的文本
否，将文档文本放入源代码然后将 .java 文件打包为 jar 无法成功悬停并显示文档。您应该使用 javadoc 从 Java 源文件生成 API 文档。

标签： java visual-studio-code jar javadoc

【解决方案1】：

要使文档在鼠标悬停时显示出来，您应该将文档文本放在标签Description之后，并使用命令javadoc生成API信息，然后将其打包为JAR。

这是一个演示项目：

/**
 * Description: This is a demo project for printing "helloworld"
 * Program Name: App
 * Date: 2020-12-16
 * @author Molly Wang
 * @version 1.0
 */
public class App {

    /**
     * member variable
     */
    public int age;

    /**
     * main method
     * @param args
     * @throws Exception
     */
    public static void main(String[] args) throws Exception {
        System.out.println("Hello, World!");
    }
}

在终端中运行以下命令。注意进入.java文件所在的文件夹。

javadoc App.java
jar cvfe App.jar App .\
将 jar 添加到引用的库中；
测试：引用 App 并将鼠标悬停在其上时，将显示描述。结果，您将文档放在 Description 之后，以便 java 扩展捕获并显示它们。

【讨论】：