【问题标题】:How to include Javadoc and source code with dependency如何包含依赖关系的 Javadoc 和源代码
【发布时间】:2021-02-25 13:47:41
【问题描述】:

我目前在 Visual Studio Code 中使用 JSoup 依赖项,但我的 Visual Studio Code 中没有 Javadoc 或 Jsoup 的源代码:

依赖

    <dependency>
      <!-- jsoup HTML parser library @ https://jsoup.org/ -->
      <groupId>org.jsoup</groupId>
      <artifactId>jsoup</artifactId>
      <version>1.13.1</version>
    </dependency>

结果

JavaDoc

javadoc 没有显示

来源

来源不显示

问题

你有什么办法解决这个问题吗?

JSoup 依赖的JavaDocSources 可以在这里找到:https://repo1.maven.org/maven2/org/jsoup/jsoup/1.13.1/

JSoup 在他们的代码中包含了 Javadoc: https://github.com/jhy/jsoup/blob/master/src/main/java/org/jsoup/nodes/Document.java

【问题讨论】:

标签: java maven visual-studio-code


【解决方案1】:

这样做:

<dependency>
  <!-- jsoup HTML parser library @ https://jsoup.org/ -->
  <groupId>org.jsoup</groupId>
  <artifactId>jsoup</artifactId>
  <version>1.13.1</version>
</dependency>
<dependency>
  <!-- jsoup HTML parser library @ https://jsoup.org/ -->
  <groupId>org.jsoup</groupId>
  <artifactId>jsoup</artifactId>
  <version>1.13.1</version>
  <classifier>sources</classifier>
</dependency>
<dependency>
  <!-- jsoup HTML parser library @ https://jsoup.org/ -->
  <groupId>org.jsoup</groupId>
  <artifactId>jsoup</artifactId>
  <version>1.13.1</version>
  <classifier>javadoc</classifier>
</dependency>

【讨论】:

  • 谢谢!知道是否可以直接在 Visual Studio Code 中进行配置?并注意pom.xml
  • 是的,您可以从这里下载源代码文件和 javadoc 文件:repo1.maven.org/maven2/org/jsoup/jsoup/1.13.1。然后你需要将它们包含到你的 Visual Studio 的类路径中,它会起作用。我不确定如何在 Visual Studio 类路径中正确包含这些文件。在 Eclipse 或 InteliJ 中,您需要创建一个包含这些 JAR 的用户库。
  • 您不要将sourcesjavadoc 放入&lt;dependencies&gt; 部分。
  • @JFabianMeier 我有自己的开源库,在我的指导方针中,我建议将源代码和 javadoc 添加到 中。当我在其他项目中使用自己的库时,我也会这样做。它工作得很好。它可能会扩大部署 jar 文件,但它有助于开发(IDE 中的调试和 javadoc 可用性。无论如何,我想听听为什么不这样做。您可以在此处回答或将其移至单独讨论。顺便说一句,我的库名为 MgntUtils,欢迎大家查阅
  • 是的,这可以做到。对 javadoc 和源依赖项使用范围“提供”(provided),它们不会包含在部署中。见此链接:maven.apache.org/guides/introduction/…
【解决方案2】:

没有办法实现您的目标,因为 jar 或依赖项本身没有文档字符串。

例如,当你点击println时,评论部分也是你将鼠标悬停在println上时的内容:

但是jsoup中没有这样的注释,所以java扩展将无法捕获文档字符串并显示它。

[更新]

jsoup/src/main/java/org/jsoup/nodes/Document.class:

jar中包含的文件全部编译为.class文件,函数前没有cmets,所以Java语言服务器无法捕捉到它显示为特征intellisense。

【讨论】:

猜你喜欢
  • 2014-11-11
  • 2021-05-05
  • 2011-10-15
  • 2015-02-12
  • 2013-06-29
  • 2012-02-02
  • 2015-10-18
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多