关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题？更新问题，以便editingthispost可以用事实和引用来回答它.关闭7年前。Improvethisquestion给定以下代码片段:/***Initializesanewinstance.**/publicCollector(){this.map=newHashMap();}请关注Javadoc评论:在这个构造函数中并没有发生太多事情。那么，为它编写Javadoc的正确方法是什么？如上图？这将是完全准确的，但同时又是多余的，因为构造函数旨在初始化一个新实例。所以，一方面，我们不想在Javadoc注释中

Java10中javadoc命令的-link选项对我来说无法始终如一地使用模块。具体来说，它在依赖模块名称与其导出的包名称相同的情况下不起作用我运行以下命令/opt/jdk-10.0.1/bin/javadoc-html5-subpackagesuk.co.sr.vcher.service\--source-pathsrc/service\--module-pathlib:app-djavadoc/service\-link../auth-link../db-link../models\-link../core-link../render\-linkhttps://docs.oracl

我正在尝试为我的项目生成JavadocHTML文件。我通过MavenJavadoc插件(maven-javadoc-plugin)生成它们。我正在使用Maven2.2.1。生成的所有内容都包含所有正确的信息，但HTML看起来很糟糕。太糟糕了，我不想那样发布。这是一个屏幕截图:(注意:是的，我看到“JavaScript在您的浏览器上被禁用”消息。即使我点击IE8关于Activity内容的警告并启用它，也没有任何区别)有各种不必要的换行符，基本格式也很垃圾。我错过了什么吗？如果我将鼠标悬停在一个类或方法上并看到弹出的Javadoc面板，我希望看到生成的Javadoc看起来与我在Eclips

我正在使用Gradle编写一个构建文件来执行Java构建操作。但是，Gradle不会为我的项目生成Javadoc。根据Gradle.org的文档，要在Gradle中实现Javadocs任务，必须指定源和类路径。applyplugin:'java'javadoc{source=sourceSets.main.allJavaclasspath=configurations.compile}但是，当我运行命令gradlejavadoc或gradlebuild时，从未创建javadocs(build\docs)的默认文件夹，因此没有html文件为项目生成。我该怎么做才能解决这个问题？

几个月来我一直在寻找答案，并且尝试了多种方法，包括解压缩压缩文件夹src.zip并将其用作Javadoc的参数(例如:javadoc-sourcepathsrccom.example.test)这是JDK6Update24附带的默认Javadoc。假设我正在制作一个实现了java.util.Map的新map界面。默认情况下，我从Map接口(interface)覆盖的方法应该从接口(interface)继承文档，如果我没记错的话。但是，javadoc永远不会这样做。到目前为止，唯一解决这个问题的方法实际上是对Java编写的类进行javadoc(例如:javadoccom.example.

我想从一个项目的所有Java源文件生成一个HTML文件。通常，JavaDoc会生成多个链接在一起的HTML页面，但我想将所有内容都放在一个页面中。这可能吗？ 最佳答案 好吧，我能够使用PDFDoclet从我的JavaDoc中获取PDF. 关于java-生成单页HTMLJavaDoc，我们在StackOverflow上找到一个类似的问题： https://stackoverflow.com/questions/13011538/

ApacheCommonsLang中ArrayUtils.isNotEmpty()的javadoc似乎是错误的。或者，至少，误导。它说Returns:trueifthearrayisnotemptyornotnull在我看来，空数组不是null。所以，根据上面的定义，isNotEmpty()应该为空数组返回true，这是违反直觉的。不会Returns:trueifthearrayisnotnullandnotempty更正确吗？ 最佳答案 Wouldn'tReturns:trueifthearrayisnotnullandnotem

我的情况是我有一个来自第三方的外部编译库(jar)，没有JavaDocs。在开发过程中，我想通过测试和使用从第3方网站获得的非常有限的文档来记录类和方法。我的最终目标是拥有一个JavaDoc文档，我将能够在IntelliJ中使用它来进行代码提示和文档查找？所以我的问题是，是否可以将JavaDocs写入我将能够导入的已编译的jar文件？也许使用有助于此的工具。 最佳答案 是的。您所要做的就是写出类和接口(interface)以及方法和变量定义，没有任何代码，就好像所有方法都是抽象的一样，然后为它们编写Javadoc注释。这实际上是Su

您好，我面临一些maven插件问题，当我尝试部署java-webservices项目时，我的项目没有下载"maven-javadoc-plugin:2.4"插件，我手动安装了“maven-javadoc-plugin2.5”版本jar到我的.m2/repository。我得到了"AnerrorhasoccurredinJavaDocsreportgeneration:Exitcode:1-javadoc:error-invalidflag:-author".谁能帮我解决这个错误，子pomorg.apache.maven.pluginsmaven-javadoc-pluginjavado

当类重写具体方法或实现抽象方法时，Javadoc将自动继承，除非明确重写。或者，至少该工具会尝试执行此操作。它似乎不适用于链接的外部API。例如，当我在我的代码中实现java.util.Map或来自JRE的其他东西时，javadoc不是从JREjavadocs/apidocs继承/复制的。在我的具体情况下，我试图在Maven2Javadoc插件中配置它，但当我直接运行javadocCLI工具时它是一样的。我的Maven2Javadoc插件配置目前如下所示:org.apache.maven.pluginsmaven-javadoc-plugin2.7mavenhttp://downloa