Tag: javadoc

在Javadocs中，我应该如何在<code>标签中编写复数forms的单数对象？: 我有一个名为Identity的类。在我的javadoc评论中，我把它作为一个复数。我可以想到两个解决scheme：将引用更改为<code>Identities</code>或<code>Identity</code> 。这些都没有感觉是正确的，我想知道是否有更好的解决scheme。这是一个清晰的例子： /** * Returns an <code>IdentityBank</code> of <code>Identity</code>s with the given sex. */ 要么 /** * Returns an <code>IdentityBank</code> of <code>Identities</code> with the given sex. */

如何在IntelliJ IDEA中查看JDK外部文档？: 此操作的快捷方式是Shift + F1，但即使我已经指出了docs文件夹的JDK documentation path （docs文件夹从jdk-7u2-apidocs.zip解压缩），它总是灰显的。谢谢

如果它像compareAndSet一样实现，weakCompareAndSet如何虚假地失败？: （注意，这个问题不是关于CAS，而是关于“可能虚假地失败”的 Javadoc）。来自AtomicInteger类的这两个方法之间Javadoc的唯一区别是weakCompareAndSet包含注释： “可能虚假地失败” 。现在，除非我的眼睛受到某种咒语的欺骗，否则这两种方法看起来都是一样的： public final boolean compareAndSet(int expect, int update) { return unsafe.compareAndSwapInt(this, valueOffset, expect, update); } /* … * May fail spuriously. */ public final boolean weakCompareAndSet(int expect, int update) { return unsafe.compareAndSwapInt(this, valueOffset, expect, update); } 所以我意识到“可能”并不意味着“必须”，但是为什么我们不把所有这些添加到我们的代码库中： public void doIt() { a(); } /** * May fail spuriously */ public […]

Eclipse Android项目中的JavaDoc: 在我们的Android项目中，我们的代码是JavaDoc，能够正确生成一切。但是，任何对Android API类/函数的引用都会导致JavaDoc错误，并且不会生成到相关信息的链接。相反，我们得到纯文本类名称。我们如何设置Eclipse将这些链接转换为在线Android API参考（最好）或本地副本（如有必要）？

/ *（非javadoc）含义: 可能重复： “/ *（非javadoc）”是否有很好理解的含义？以下表述是什么意思？ /* (non-Javadoc) * * Standard class loader method to load a class and resolve it. * * @see java.lang.ClassLoader#loadClass(java.lang.String) */ @SuppressWarnings("unchecked")

如何在Javadoc中创build多个缩进级别？: 假设，作为logging你的代码（Javadoc）的一部分，你要表明使用深度缩进的元素之间的关系。我如何创build一个嵌套列表为：一些元素一些其他元素还有一些其他元素

如何编写javadoc链接？: 我如何写入链接到javadocs？目前，我有这样的东西： {@link java.lang.Math#sqrt(double) Math.sqrt} 生成应该链接到java.lang.Math.sqrt(double) API的文本Math.sqrt ，但是它所做的只是生成文本，没有链接。

我如何启用Android支持库的javadoc？: 在使用Android支持库进行兼容性时，如果尝试查看用于FragmentTransaction的javadoc，则会出现以下错误，因为没有关联的javadoc文件： android.support.v4.app.FragmentTransaction 注意：这个元素既没有附加源代码，也没有附加Javadoc，因此没有findJavadoc。支持库被添加到项目属性中的Android Dependencies项下，并显示Javadoc的位置:(无） – 不可修改，如下所示。有没有解决方法？

在JavaDoc中重写的方法: 我logging了我开发的一个Java程序，并且想知道如果我只是logging超类，JavaDoc是否将为inheritance的方法（被重写）生成？如果我有一个名为Vehicle带有drive()方法的类drive()和一个名为Car且具有重写的drive()方法的子类，那么如果没有放入Javadoc，则将车辆驱动方法的文档包含在Cars驱动器方法中在汽车类？

为什么默认的IntelliJ默认类javadoc注释使用非标准语法？: 为什么默认的IntelliJ默认类javadoc注释使用非标准语法？可以用“@author jstauffer”创build一行，而不是用“User：jstauffer”创build一行。它创build的其他行（date和时间）可能没有使用javadoc语法，但为什么不在可用时使用javadoc语法？这里作为参考是一个例子： / ** *由IntelliJ IDEA创build。 *用户：jstauffer *date：2007年11月13日 *时间：上午11:15:10 *要更改此模板使用文件| 设置| 文件模板。 * /