Tag: javadoc

如何在JavaDocs中引用“* /”

我有一个需要包括*/在我的JavaDoc评论。 问题是，这也是closures评论的相同顺序。 引用/逃避这个的正确方法是什么？ 例： /** * Returns true if the specified string contains "*/". */ public boolean containsSpecialSequence(String str) 跟进 ：看来我可以使用/ 为斜线。 唯一的缺点是，当在文本编辑器中直接查看代码时，这不是完全可读的。 /** * Returns true if the specified string contains "*/". */

C ++的类Javadoc文档

有类似的文档生成系统，如Javadoc，C ++？ Javadoc产生很好的输出; 如果你能在其他语言中使用类似的东西，那将是非常好的。

在Intellij中自动完成@author

我正在从Eclipse迁移到Intellij Idea。 有一件事我还@author不清楚@author JavaDoc标签的自动完成。 在Eclipse中input@a时，有两个提议： @author – author name @author 如何在Intellij中实现第一个提议（甚至有可能？）？ 如果可能的话，如何更改为作者姓名占位符插入的模板？

如何链接javadoc私人领域？

我怎么能做一个私人领域的javadoc链接？ class Foo { private String bar; public String getBar() { return bar; } } {@link Foo#getBar()}起作用。 {@link Foo#bar}不会。

如何从命令行生成Javadoc

任何人都可以告诉我如何从命令行生成Javadoc？ 我的项目包含com.test包，我想把生成的文件放在一个特定的文件夹中，如下所示： C:/javadoc/test 。

使用Android Gradle插件生成JavaDocs

我如何使用新的Gradle构build系统为Android项目生成JavaDocs？ 这是我想出来的，但不起作用。 task generateJavadoc(type: Javadoc) { source = android.sourceSets.main.java.srcDirs ext.cp = android.libraryVariants.collect { variant -> variant.javaCompile.classpath.files } classpath = files(ext.cp) } 主要的问题是我没有在类path上得到合适的android.jar，因此JavaDocs中的一些链接没有parsing。 我必须find一种方法来获得类path中所有必需的jar。 我采取的方法的另一个问题是收集所有构build变体的类path，而不是select一个。

JDK 8中的Javadoc：无效的“自闭元素不允许”

使用JDK 8运行javadoc时遇到的最好的解决方法是什么？ 看来对于JDK 8，已经决定像<br />和<p />这样的标签应该会产生错误，因为它们是无效的（严格的）HTML 4. 请参阅讨论JDK邮件列表 我想知道，因为我只是想使用maven编译一些java项目，并绊倒了这个问题。 当然，我可以在项目中提交一张票（我想我会的），但是如果有一种方法可以禁用这种行为（对于一台机器），那将是非常好的。 否则，我预计很多项目需要修复，然后才能在JDK 8上构build而不会出现问题。

如何查看有关鼠标hover在NetBeans上的Javadoc文档？

是否有可能，当你鼠标hover在方法/类，所以你可以在NetBeans 7中看到Javadoc？ 我想要类似于Eclipse，当你只是鼠标hover在String ，你可以阅读关于它的Java API文档。 也许有一些热键…

Javadoc @author标签的良好做法

创buildJavadoc时，我想知道最佳做法。 我有一个项目与许多文件。 代码已经由许多开发人员创build。 每个文件都有注解@author ，所以很明显是谁创build了一个特定的类。 但是，当其他开发人员向文件添加新代码，修改文件等时，他应该如何通知团队的其他成员他已经创build了一些新function或修改了现有代码？ 换句话说，我们应该如何“保持Javadocs与现实相容”？ ;） 将他的名字添加到现有的@author标签？ 那么，如果有任何疑问，更容易确定问谁。 为每个新的方法，内部类等添加一个@author标签？ 当然，因为我们使用SVN，所以很容易调查谁做了什么，但为了保持清晰，这个Javadoc的东西也应该被考虑到。 什么是使用这些@author标签的最佳方式？

使用JavaDoc来loggingJava枚举的最佳方式是什么？

我刚刚开始在自己的项目中使用Java的枚举（我必须在工作中使用JDK 1.4），对于将JavaDoc用于枚举的最佳做法我感到困惑。 我发现这个方法是有效的，但是最终的代码有点不确定： /** * Doc for enum */ public enum Something { /** * First thing */ FIRST_THING, /** * Second thing */ SECOND_THING; //could continue with more } 有没有什么办法可以打破自己的行的枚举声明没有用逗号链接，或者这是使用JavaDoc的枚举最好的方法？