标签: javadoc

我有两个包,Shapes并且Fruits:

com.myproject.Shapes.
    Circle
    Square
    Triangle
com.myproject.Fruits.
    Apple
    Orange

我正在编写JavaDoc Apple并且需要提供一个{@link}to Square.

我已经尝试了以下所有方法,但没有一个工作:

{@link Square}
{@link com.myproject.Square}

我已经能够找到链接到以下内容的文档:(a)同一个包中的类,或(b)外部URL,但不包含另一个包中的类.

任何想法正确的语法应该是什么？谢谢!

任何人都可以告诉我如何从命令行生成Javadoc？

我的项目包含包com.test,我想将生成的文档放在特定文件夹中的文件中,如下所示:C:/javadoc/test.

我想知道创建Javadocs时的最佳实践.我有一个包含许多文件的项目.代码已由许多开发人员创建.每个文件都有一个注释@author,因此很明显谁创建了一个特定的类.

但是当其他开发人员向文件添加新代码,修改它等等时,他应该如何通知团队的其他成员他已经创建了一些新功能或修改了现有代码？换句话说,我们应该如何"让Javadocs与现实保持一致"？;)

• 将他的名字添加到现有@author标签？然后,如果有任何疑问,更容易识别要询问的人.
• @author为每个新方法,内部类等添加标记？

当然,由于我们使用SVN,很容易调查谁做了什么,但为了保持清楚,这个Javadoc的东西也应该被考虑在内.

使用这些@author标签的最佳方法是什么？

我正在使用ant生成javadocs,但一遍又一遍地得到这个例外 - 为什么？

我正在使用JDK版本1.6.0_06.

[javadoc] java.lang.ClassCastException: com.sun.tools.javadoc.ClassDocImpl cannot be cast to com.sun.javadoc.AnnotationTypeDoc
  [javadoc]     at com.sun.tools.javadoc.AnnotationDescImpl.annotationType(AnnotationDescImpl.java:46)
  [javadoc]     at com.sun.tools.doclets.formats.html.HtmlDocletWriter.getAnnotations(HtmlDocletWriter.java:1739)
  [javadoc]     at com.sun.tools.doclets.formats.html.HtmlDocletWriter.writeAnnotationInfo(HtmlDocletWriter.java:1713)
  [javadoc]     at com.sun.tools.doclets.formats.html.HtmlDocletWriter.writeAnnotationInfo(HtmlDocletWriter.java:1702)
  [javadoc]     at com.sun.tools.doclets.formats.html.HtmlDocletWriter.writeAnnotationInfo(HtmlDocletWriter.java:1681)
  [javadoc]     at com.sun.tools.doclets.formats.html.FieldWriterImpl.writeSignature(FieldWriterImpl.java:130)
  [javadoc]     at com.sun.tools.doclets.internal.toolkit.builders.FieldBuilder.buildSignature(FieldBuilder.java:184)
  [javadoc]     at sun.reflect.GeneratedMethodAccessor8.invoke(Unknown Source)
  [javadoc]     at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
  [javadoc]     at java.lang.reflect.Method.invoke(Method.java:597)
  [javadoc]     at com.sun.tools.doclets.internal.toolkit.builders.FieldBuilder.invokeMethod(FieldBuilder.java:114)
  [javadoc]     at com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder.build(AbstractBuilder.java:90)
  [javadoc]     at com.sun.tools.doclets.internal.toolkit.builders.AbstractMemberBuilder.build(AbstractMemberBuilder.java:56)
  [javadoc]     at com.sun.tools.doclets.internal.toolkit.builders.FieldBuilder.buildFieldDoc(FieldBuilder.java:158)
  [javadoc]     at sun.reflect.GeneratedMethodAccessor51.invoke(Unknown Source)
  [javadoc]     at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
  [javadoc]     at java.lang.reflect.Method.invoke(Method.java:597)
  [javadoc]     at com.sun.tools.doclets.internal.toolkit.builders.FieldBuilder.invokeMethod(FieldBuilder.java:114)
  [javadoc]     at com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder.build(AbstractBuilder.java:90)
  [javadoc]     at com.sun.tools.doclets.internal.toolkit.builders.AbstractMemberBuilder.build(AbstractMemberBuilder.java:56)
  [javadoc]     at com.sun.tools.doclets.internal.toolkit.builders.ClassBuilder.buildFieldDetails(ClassBuilder.java:301)
  [javadoc] …

对于C++,是否有像Javadoc这样的文档生成系统？Javadoc产生了很好的输出; 如果你能在其他语言中使用类似的东西,那就太棒了.

是否有可能,当您将鼠标悬停在方法/类上时,您可以在NetBeans 7中看到Javadoc？

我想要类似于Eclipse,当你只是鼠标悬停时String,你可以阅读有关它的Java API文档.

也许有一些热门关键......

在OpenJDK中,对于方法:

public static Double valueOf(double d)

javadoc说:

返回表示指定double值的Double实例.如果不需要新的Double实例,通常应优先使用此方法,而不是构造函数Double(double),因为此方法可能通过缓存频繁请求的值来显着提高空间和时间性能.

这是实际的代码:

public static Double valueOf(double d) {
    return new Double(d);
}

缓存是谎言!这里发生了什么？

我正在记录我开发的Java程序,并想知道如果我只记录超类,是否会为继承的方法(被覆盖)生成JavaDoc？

如果我有一个Vehicle使用drive()方法调用的类,并且Car使用drive()方法覆盖调用的子类,如果没有将Javadoc放入Car类中,那么Vehicle驱动方法的文档是否会包含在Cars驱动方法中？

使用JDK 8运行javadoc时遇到的最佳解决方法是什么,并且收到此错误.

似乎对于JDK 8,已经确定标签喜欢<br />并且<p />应该生成错误,因为它们是无效的(严格的)HTML 4. 请参阅讨论JDK邮件列表这里

我想知道,因为我只想使用maven编译一些java项目并在这个问题上绊倒.当然,我可以使用该项目提交一张票(我想我会这样),但是如果有一种方法可以禁用这种行为(对于一台机器),那将会很棒.否则,我希望在没有问题的情况下在JDK 8上构建之前需要修复很多项目.

Exit code: 1 - javadoc: error - The code being documented uses packages in the unnamed module, but the packages defined in https://docs.oracle.com/en/java/javase/11/docs/api/ are in named modules.

有没有人能够使 javadoc 工作而不必将源版本更改为 1.8（如其他论坛中所建议的那样）？我正在使用 JDK v11.0.5 并且问题仍然存在（JDK 12+ 也是如此）。

编辑：此错误源自 maven 并由 maven-javadoc-plugin 抛出。即使使用<source>8</source>配置，我也无法使其适用于 JDK 11+ 。