Tag: javadoc

javadoc的语法高亮？: 目前我使用PRE标签在我的javadoc中格式化代码示例，例如： /** * Example javadoc * String foo = “bar”; * * @return true if the operation completed */ 但是在生成的javadoc中，这看起来相当单调乏味，我更倾向于使用类似于SyntaxHighlighter的语法突出显示。如何才能做到这一点？

如何在JDK 7中使用旧的javadoc样式/主题？: JDK 7中用于javadoc的新主题对我来说很难阅读。它可能不漂亮，但我真的更喜欢旧的主题。除了安装旧的JDK并在它们之间切换之外，我可以以某种方式使用旧的doclet吗？

如何使用IntelliJ将外部库的源和javadoc添加到gradle中？: 我用IntelliJ和Gradle建立了一个Java项目。我的根项目中有一个build.gradle文件，我可以编译并运行我的应用程序。但是……我正在使用一个带有源和javadoc zip文件的Java库。如果我在我的源代码中并且想要从这个库中获取类或方法的声明，IntelliJ会调出.class文件而不是zip中提供的源.java文件。如何告诉gradle使用随外部库提供的源和javadoc zip？

如何为图书馆分发Javadoc？: 我正在写一个自定义库。它构建成.jar存档。我完全能够生成javadoc，但我不知道应该如何分发它？将它放在与库相同的.jar中把它放在一个不同的.jar中还有其他方法吗？以及如何将javadoc包含在另一个使用我的lib的项目中？如果我把它放在同一个.jar中，我应该在清单中写一些东西吗？如果它在一个单独的.jar中，是否足够包含在项目中？我正在使用NetBeans 9.1。

用自上而下的方法用Java设计API – 写Javadoc是最好的起点吗？: 每当我需要在Java中设计API时，我通常会先打开我的IDE，然后创建包，类和接口。方法实现都是虚拟的，但javadocs是详细的。这是最好的办法吗？我开始觉得API文档应该是第一个被淘汰的 – 甚至在第一个.java文件被写入之前。这几点没什么优势： API设计人员可以完成设计和规范，然后在多个实现者之间拆分实现。更灵活 – 设计更改不需要在java文件中反弹，寻找编辑javadoc注释的位置。还有其他人分享这个观点吗？如果是这样，您如何开始使用API设计？此外，有没有可能有帮助的工具？甚至可能是某种基于注释的工具，它可以生成文档，然后生成骨架源（类似于模型到代码生成器）？我遇到了Eclipse PDE API工具 – 但这是Eclipse插件项目特有的。我没有找到更通用的东西。

通用javadoc命令总是生成给定树中的所有javadoc？: 当我必须为一个新的，不熟悉的项目生成javadoc时，我发现我花了很长时间尝试简单地编写正确的命令，指定所有包，所有源树等。这是耗时且容易出错的：我可能错过了一些消息来源。所以假设我有一个目录myproj，在它下面有一些包（以及各种其他资源和东西），在这些包目录下最终有一些src /目录，然后是很多我的/ awesome / java / project /包类型结构。是否有一个命令总是会在一切情况下递归并在一个输出位置生成所有javadoc？我不在乎需要多长时间。像javadoc -d doc -sourcepath . -subpackages *那样脑力javadoc -d doc -sourcepath . -subpackages * javadoc -d doc -sourcepath . -subpackages *会很棒。如果失败了，无论目录结构是什么，生成所有javadoc的最简单方法是什么？

javadoc 1.5和1.6中缺少enum.valueOf（String name）: 这可能是一个愚蠢的问题，但我使用的方法是enum.valueOf(String name) 。没问题，除了当我检查javadoc以了解更多有关此方法的信息时，我找不到它。 valueOf(Class enumType, String name)有javadoc，但enum.valueOf(String name) （这表明不存在具有此签名的方法 – 但显然它确实存在）。我在这里遗漏了什么，或者这是对API的javadoc的疏忽？谢谢

无法在Javadoc注释中链接到JDK10: 从Java 9升级到10后，使用Javadoc工具生成文档时，指向JDK的链接不再有效（例如，对于导入java.util.Optional的文件， {@link Optional}呈现为Optional而不是Optional ;同样的问题与@return see， @return @param ， @return以及其他任何你通常看到Javadoc链接的地方）。我有一个简单的模块化项目，我正在使用Maven和Javadoc插件（在编译器插件的configuration部分中将source和target选项设置为10 ）。我的理解是默认情况下它将-link https://docs.oracle.com/javase/10/docs/api/传递给Javadoc工具。这也是我的理解，从历史上看，Javadoc工具期望一个名为package-list的文本文件出现在它被告知要查找外部文档的URL中。 Java 8 有一个。 Java 9 有一个。 Java 10 没有（404错误）。显然，Javadoc工具现在为模块化项目输出一个名为element-list而不是package-list的文本文件，但似乎也没有提供（Java9也没有提供，但它可用于早期访问的Java构建11 ）。通过IntelliJ生成Javadoc，并启用了启用Link to JDK documentation的选项Link to JDK documentation可以产生相同的结果。它说传递-link https://docs.oracle.com/javase/10/docs/api/到javadoc.exe ，它报告javadoc: error – Error fetching URL: https://docs.oracle.com/javase/10/docs/api/ 。尽管有错误，它确实输出了Javadoc，但与Maven一样，没有JDK链接。这应该怎么样？当他们将JDK文档放到网上时，Oracle是否搞砸了？我的pom.xml的相关部分： org.apache.maven.plugins maven-compiler-plugin 3.7.0 […]

Javadoc插入UML图: 有没有办法将图像嵌入我的JavaDoc？基本上我想在一些文档中包含一些UML图解释我的类的层次结构。谢谢！

使用GitHub提供JavaDocs，Sonatype Maven repo: 虽然Github为Java开源项目提供了一个很好的家，但与更成熟的开源托管位置相比，仍有一些东西仍然缺失。到目前为止，我已经发现Sonatype为开源项目提供了Maven存储库访问，这解决了一个问题; 用户/ dev邮件列表有很多解决方案。但我现在试图解决的一件事是发布自动生成的javadocs用于在线浏览。尽管通过Maven发布源代码jar对IDE有所帮助，但我仍然希望能够在线浏览javadoc而无需下载或导入项目。对于在Github上托管的项目，是否有人知道实现这一目标的好方法？（不一定是Github提供的东西，但理想情况下，当发布被削减时可以自动化的东西）