Tag: javadoc
你使用Javadoc你写的每一个方法？
我应该为我所有的java方法写文档注释吗？
Javadoc重用和重载的方法
我正在开发一个具有许多相同命名方法的API，这些方法只是因签名而异，我猜这是相当普遍的。 他们都做同样的事情，除了他们默认初始化各种值，如果用户不想指定。 作为一个可消化的例子，考虑一下 public interface Forest { public Tree addTree(); public Tree addTree(int amountOfLeaves); public Tree addTree(int amountOfLeaves, Fruit fruitType); public Tree addTree(int amountOfLeaves, int height); public Tree addTree(int amountOfLeaves, Fruit fruitType, int height); } 所有这些方法的基本操作都是一样的。 一棵树种在森林里。 API的许多重要用户需要了解添加树的方法。 理想情况下，我想编写一个所有方法都使用的Javadoc块： /** * Plants a new tree in the forest. Please note that it may take * […]
在Intellij IDEA中附加额外的javadoc
当我使用j2ee类中的快速文档查找（Ctrl + Q）或IDEA中的注释时，我只能得到一个空的javadoc。 它只包含类名的基础知识。 如何将javadoc添加到libs IDEA提供的自身？
@see和@inheritDoc之间的区别细节
我已经看了JavaDoc的参考 ，虽然我了解@see （各种链接）和{@inheritDoc} （超类JavaDoc注释的导出）之间的基本区别，我需要澄清事情如何实际执行。 在Eclipse IDE中，当我为inheritance的方法（从接口，或toString（）覆盖等等）select“生成元素注释”时，会创build以下注释 /* (non-Javadoc) * @see SomeClass#someMethod() */ 如果我需要生成JavaDoc，我应该把它{@inheritDoc} ，用{@inheritDoc}replace@see ，或者把它转换成真正的 JavaDoc： /** * {@inheritDoc} */ 当我这样做的时候，我还应该保留class＃方法标志吗？
Javadoc：没有HTML标签的换行符？
对不起，有一个可能的常见问题types的问题，但我只是找不到答案。 就我所记得的Eclipse而言，Javadoc注释中的空行显示为（在内源Javadocpopup窗口中）作为换行符（具有额外的垂直间距）。 但是在Netbeans中，事实并非如此。 我可以configurationJavadoc将空行解释为换行符吗？ 额外的问题：我可以重写默认的NetBeans的行为（与此相关）源Javadocpopup窗口？ 我在说的是： 资源 /** * Paragraph One * * Paragraph Two */ void someMethod() { } Eclipse解释 Paragraph One Paragraph Two Netbeans的解释 Paragraph One Paragraph Two
Javadoc链接到另一个包
我有两个包， Shapes和Fruits ： com.myproject.Shapes. Circle Square Triangle com.myproject.Fruits. Apple Orange 我正在为Apple编写JavaDoc，并需要向Square提供一个{@link} 。 我尝试了以下所有内容，而且都没有工作： {@link Square} {@link com.myproject.Square} 我已经能够find链接到以下内容的文档：（a）同一个包中的类，或者（b）外部URL，而不是另一个包中的类。 任何想法正确的语法应该是什么？ 谢谢！
为什么javadoc的Double.value说它caching价值，当它不？
在OpenJDK中，对于方法： public static Double valueOf(double d) javadoc说： 返回一个Double实例，表示指定的double值。 如果不需要新的Double实例，则通常应该优先使用此方法（优先于构造函数Double（double）），因为此方法通过caching频繁请求的值可能会产生显着更好的空间和时间性能。 这是实际的代码： public static Double valueOf(double d) { return new Double(d); } caching是一个谎言！ 这里发生了什么？
为什么在生成javadoc时得到一个ClassCastException？
我用ant来生成javadoc，但一遍又一遍地得到这个exception – 为什么？ 我正在使用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 […]
如何将Java API文档添加到Eclipse？
我已经从http://www.oracle.com/technetwork/java/javase/downloads/index.html#docs下载了Java API文档，并假定使用 Window-> Preferences-> Java-> Installed JREs-> Edit – >“Select rt.jar” – > Javadoc Location 地点已被接受，“validation”就好了。 然而，对于我来说，我不能让Eclipse在工具提示中显示Javadoc，而不是将鼠标hover在某个项上（例如在ArrayList的声明中）。 我也尝试启动Eclipse以重新启动Eclipse 我究竟做错了什么？
如何Javadoc一个类的个人枚举
我正在为包含它自己的枚举的类编写javadoc。 有没有办法为单个枚举生成javadoc？ 例如，现在我有这样的东西： /** * This documents "HairColor" */ private static enum HairColor { BLACK, BLONDE, BROWN, OTHER, RED }; 但是，这仅仅logging了所有的枚举： 有没有办法单独logging每个HairColor值？ 没有将枚举移入它自己的类或将其从枚举中更改？ 在此先感谢您的帮助。
