java—编译到jar时文档不起作用

zynd9foi 于 2021-07-03 发布在 Java

关注(0)|答案(1)|浏览(296)

我正在用一些有用的类为java创建自己的包。在其中的许多地方，我添加了一些文档。它在编辑源文件（我正在使用vs代码）时非常有效，但是在仅引用已编译的jar库时它不会出现。另外，当ctrl单击一个类时，它表示它无法加载源代码，只是生成了一个模板。然而，实际的代码运行得很好。有人能帮我吗？我在这部纪录片中做了不少工作，如果不能使用，那就太可惜了。顺便说一下：我使用了java项目扩展中的jar编译器。

Java visual-studio-code Jar Javadoc

来源：https://stackoverflow.com/questions/65186832/documentation-not-working-when-compiled-to-jar

1条答案

按热度按时间

pexxcrt21#

要使文档在悬停在其上时显示出来，您应该将文档文本放在标签描述之后并使用命令 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添加到引用的库中；
测试：当您引用应用程序并将鼠标悬停在其上时，将显示说明。结果，您将文档放在描述之后，以便java扩展捕获并显示它们。