Tag: javadoc

Mac OS X上的IntelliJ IDEA中的JDK文档

我想知道如何将IntelliJ设置为指向JDK文档,以便在代码完成期间显示的文档popup窗口会显示我正在查看的function。 出于某种原因,IntelliJ默认情况下无法findJavaDocs。 我也不能100%确定文档是与安装在操作系统中的JDK一起安装的。 我没有在/System/Library/Frameworks/JavaVM.framework/中看到它们,但是我可能正在寻找错误的地方。 如果没有包含它,我还想知道需要下载哪些内容以及需要安装的位置,以便让JDK的JavaDocs显示在IntelliJ中。

我怎样才能引用javadoc类中的最终静态字段的值?

/** * This is a simple class with only one static field with the value ???. */ public class Simple { /** * We can reference the value with {@value} here, * but how do we reference it in the class JavaDoc? */ public static final String STATIC_FIELD = "simple static field"; } 代码说明了这一切:-)提前感谢您的帮助! 编辑:我真正想要的是“???” […]

如何编写属性的Javadoc?

当我为javadoc写一个“简单”的POJO类的属性/成员时,我经常发现自己陷入困境,这个POJO类只有属性,getter和setter(DTO风格)…. 1)为属性写javadoc 要么… 2)为getter写javadoc 如果我为该属性编写javadoc,则当我稍后通过代码完成访问POJO时,我的IDE(Eclipse)将自然地无法显示此内容。 而且没有标准的javadoc标签,可以让我将getter-javadoc链接到实际的javadoc属性。 一个例子: public class SomeDomainClass { /** * The name of bla bla bla */ private String name; /** * @return INSERT SOME SMART JAVADOC TAG LINKING TO name's javadoc */ public String getName() { return name; } 所以,基本上听听其他人如何让你的Eclipse IDE为你的getter显示javadoc属性描述,而不必复制javadoc注释会很有趣。 截至目前,我正在考虑让我的做法只logging获得者,而不是属性。 但它似乎不是最好的解决scheme…

Eclipse生成Javadoc向导:什么是“Javadoc命令”?

我想为我正在使用的开源代码库生成javadoc。 但是我被Eclipse Generate JavaDoc向导要求提供一个“Javadoc Command”,这个帮助并没有解释这意味着什么。 它想要的path到javadoc二进制/ jar或其他东西?

如何在Eclipse中附加任何jar文件的源代码或JavaDoc,例如JavaFX?

目前我正在与JavaFX合作。 每当我将鼠标hover在JavaFX的一个方法上,它给我提供了以下错误: 'Note: This element neither has attached source nor attached Javadoc and hence no Javadoc could be found' 我应该如何解决这个问题? 我怎样才能附加的javadoc或来源,使我可以看到方法的描述?

在JavaDoc中使用@see?

何时使用@see处理JavaDocs? 它的用法是什么? 例如,如果MethodA调用MethodB那么我必须将@see放在MethodB的javadoc中,并引用MethodA因为这就是调用它的方法,或者我必须从MethodA引用MethodB ,因为它调用它。 我已经阅读了Oracle网站上关于@see ,在我看来,这是非常含糊的,它表示这意味着“也看到”,但不是真正的意思!

有没有一些好的和现代的替代Javadoc?

让我们面对现实:你不需要成为一个devise师,看看默认的Javadoc看起来很丑 。 网上有一些资源提供了重新devise的Javadoc。 但是默认行为代表了产品,应该是相当好看的。 另一个问题是,与其他类似资源相比,Javadoc的可用性不是最新的。 特别是巨大的项目很难通过Firefox的快速search进行导航。 实际问题: 是否有任何独立的(桌面)应用程序能够以比浏览器更有用的方式浏览现有的Javadoc? 我正在考虑像Mono的文档浏览器。 理论问题: 有没有人知道,如果有计划进化Javadoc,以某种标准化的方式? 编辑: 一个有用的链接到这个主题太阳维基 。

我应该使用JavaDoc弃用还是Java中的注释?

目前有两种方法可以将代码标记为java中的depreacted。 通过JavaDoc /** * @deprecated */ 或者作为一个注释: @Deprecated 这是我的问题 – 我发现在使用Eclipse时将方法标记为不赞成时,声明两者都有点过分。 我真的只想使用其中之一。 但是使用注释给编译器提供了实际有用的附加信息吗? 但只使用注释,我不能说明为什么该方法不推荐使用 – 我只能用JavaDoc来做到这一点,而不使用specling为什么不好。 那么,我只能使用其中之一吗? 或者我应该学会如何指定两者?

Javadoc评论是否应该添加到实现?

在界面中添加Javadoc注释并在实现中添加非Javadoc注释是否正确? 自动生成注释时,大多数IDE都会为实现生成非JavaDoc注释。 具体的方法不应该有描述吗?

Eclipse如何链接一个包含javadocs /源的jar与它的二进制文件?

我想将鼠标hover在某个类上的jar文件中包含的javadoc注释显示在eclipse中。 例如下载JODA-2.0后,得到三个jar子: 乔达 – 时间 – 2.0 乔达 – 时间 – 2.0的Javadoc joda-time-2.0-sources( http://sourceforge.net/projects/joda-time/files/joda-time/2.0/joda-time-2.0-dist.zip/download ) 在eclipse中,[右键项目 – >属性 – > Java构buildpath – >库 – >添加JARs …]包括工程中的二进制文件(可以引用这些类)为joda-time-2.0.jar。 但是,如何链接其他两个jar文件中包含的sources / javadoc注释,以便当我将鼠标hover在这些类上时,我可以看到javadoc? 将其他两个jar(joda-time-2.0-javadoc.jar和joda-time-2.0-sources.jar)添加到构buildpath中,不会链接javadoc或源文件。