javadoc相关内容

创建使用收藏夹图标的 Javadoc HTML 页面

我想在生成的 Javadoc HTML 的 中包含一个元素: 请注意，我正在使用 Ant 任务来生成 Javadoc. 我尝试使用 Ant 任务的 元素，但放置在那里的任何标记都以 标记结束，该标记无效且因此被浏览器忽略. 解决方案 我肯定会修改输出文件作为一个简单的蛮力解决方案.但一种复杂的方法是使用自定义 doclet.此 doclet 将是标准 doclet 的副本(在 ..
发布时间：2021-11-11 03:02:01 Java开发

javadoc 从类中排除一些公共方法

我必须将类的一些公共方法排除在 javadoc 中.我尝试了 Chris Nokleberg 的 ExcludeDoclet (sixlegs).但是 doclet 给出了一个小问题:如果类中的其他方法返回 List(或任何其他泛型)，而不是在 javadoc 中显示为 List，返回类型只是显示为 List(没有通用信息) 任何人都可以就如何解决这个问题给出提示或提供解决方法吗? 解 ..
发布时间：2021-11-11 03:00:22 Java开发

为 Gradle Javadoc 任务指定所需的包

我正在尝试将 ant 构建文件转换为 Gradle，我想知道是否有一种方法可以像“packagenames"在 ant 中的工作方式一样指定 javadoc 中应该包含哪些包? 谢谢乔纳森 解决方案 请参阅 'includes'/'excludes' 属性，或相关方法.模式使用与 ant 相同的语法. javadoc {排除“**/内部/**"} 再举一个例子，如果构建过程将 J ..
发布时间：2021-11-11 02:56:12 其他开发

Ant/Maven:“javadoc:警告 - 获取 URL 时出错"；

我最近设置了我的构建服务器 (Jenkins) 来为 Ant 构建生成 Javadoc.但是，无论我做什么，我都无法让它包含指向外部库的链接.当我尝试使用在线链接时，Ant 返回: [javadoc] javadoc:警告 - 获取 URL 时出错:http://docs.oracle.com/javase/6/docs/api/package-list 当我使用离线链接并引用包列表的本地副本 ..
发布时间：2021-11-11 02:42:55 Java开发

继承 javadoc，不为继承的源生成文档

我希望 class B 从它实现的接口 interface A 继承 Javadoc.我在我的 Javadoc 命令中包含了 interface A 的源代码，并且 class B 正确地继承了文档. 现在我想知道是否可以让它生成的链接指向网络上 interface A 的文档，而不是在我的网站上复制它，即“指定者:"链接将链接到外部页面. 这可能吗? 解决方案 有可能，是的. ..
发布时间：2021-11-11 02:07:29 Java开发

如何让 Ant Javadoc 类排除两个文件?

我正在记录一些 Java 网络服务和支持的数据类型.有两个服务我不想记录.从 Ant javadoc 任务中排除少量文件的正确方法是什么? 我已经尝试使用嵌套在源路径或源文件下的文件或文件集进行多次迭代，其中包含和排除的各种组合. 我正确定义的基本目标记录了我的所有网络服务: ..
发布时间：2021-11-11 02:07:20 Java开发

如何从 javadoc Ant 任务的结果中排除特定的方法/构造函数?

我正在使用由 javadoc Ant 任务生成的 javadoc 来记录 Web 服务，并且我想从输出中排除一些构造函数.我该怎么做? 解决方案 对于公共方法没有办法做到这一点.标准做法(即使在相当多的 JDK 类中)是表明该方法或构造函数不供公共使用. 有一个 计划添加@exclude 标签未来: @exclude - 用于排除的 API由 Javadoc 生成.程序员将标记 ..
发布时间：2021-11-11 01:58:16 Java开发

是否可以在 Eclipse 中显示方法参数的注释?

我们使用注释@javax.annotation.Nullable 和@javax.annotation.Nonnull 来记录方法参数的行为. 是否可以在 Eclipse 的 JavaDoc 弹出窗口中显示此注释?我的意思是当我用鼠标移动到一个方法上时出现的弹出窗口.目前Eclipse只显示方法self的注解，不显示参数的注解. 解决方案 我使用的是 Indigo SR1 [Java ..
发布时间：2021-11-10 23:16:52 Java开发

如何让 Eclipse 显示 javax 注释的 Javadoc

我真的很喜欢 Eclipse 为我使用的各种 Java 库类弹出 Javadoc 文档的方式.但是，我也使用 JPA 和 JAXB 注释，例如 @Entity 和 @XMLType.Eclipse 将这些识别为有效，因为我可以按 ctrl-space 并弹出它们.我还获得了 javax 类的 Javadoc. 但是没有这些注释的 Javadoc...它只是报告找不到 Javadoc. ..
发布时间：2021-11-10 23:10:00 其他开发

在代码中处理/格式化 Javadoc 和注释的最佳方法是什么?

我浏览过这个论坛，并在 google 上搜索过这个论坛，但我不确定处理 Javadoc 和出现在同一个类中的注释的最佳方法是什么. 从我从 Sun/Oracle 的文档中可以看到，他们似乎建议(尽管我找不到明确的声明)Javadoc 应该列在注释之上. 查看他们的示例如何以及何时弃用 API. 这对于像@Deprecated 或@Override 这样简单的事情非常有用.但是如果 ..
发布时间：2021-11-10 23:06:11 Java开发

为什么@Documented 注释具有运行时保留?

据我所知，@Documented 注释仅由 javadoc 生成器用于从源生成 javadoc.所以保留类型应该是SOURCE，但它是RUNTIME.为什么? @Documented@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.ANNOTATION_TYPE)公共@interface 记录{} 解决方案 IMO 没有解释为什 ..
发布时间：2021-11-10 22:48:02 Java开发

禁用 JavaDocs 的注释

是否有注释声明某个方法即使是公开的也不会包含在 JavaDocs 中? 类似于: @nojavadocs公共无效 foo(){//...} 附言我理解这里关于 API 的观点，但这些方法只是“不受支持".它们可以工作(并且必须公开以便从其他包访问)，但是我们不想费心记录它们并回答有关在它们的功能与支持的使用场景不相关时如何使用它们的问题.好的设计可能意味着将它们移动到另一个类，但它们在逻 ..
发布时间：2021-11-10 22:32:04 Java开发

有没有办法让 javadoc 工具记录注释?

在我的项目中，我们使用了许多在 javadoc API 文档中看到的非常有用的注释. 有人知道在生成的 javadoc 中包含注释的简单方法吗?我不想编写自己的 javadoc 插件.有什么解决办法吗? 解决方案 参见 java.lang.annotation.Documented 表示默认情况下，带有类型的注解将由 javadoc 和类似工具记录.此类型应用于注释类型声明，这 ..
发布时间：2021-11-10 22:15:49 Java开发

Javadoc 使用@value 显示内部类常量的值

我有一个内部类，它声明了一个常量，并希望使用 @value 注释在封闭的顶级类的 Javadoc 中显示其值.例如: /*** {@value #FOO_CONS}//这显示得很好* {@value #BAR_CONS}//这不起作用(在最新的 Eclipse 中检查)* {@value Bar#BAR_CONS}//这也不起作用*/公共 Foo {public static final int ..
发布时间：2021-11-10 22:14:25 Java开发

代码风格；将 javadoc 放在注释之前还是之后?

我知道这不是最重要的问题，但我刚刚意识到我可以将 javadoc 注释块放在注释之前或之后.我们希望采用什么作为编码标准? /*** 这是注解前的 javadoc 注释*/@成分公共类 MyClass {@自动连线/*** 这是注解后的javadoc注释*/私人 MyOtherClass 其他；} 解决方案 在注解之前，因为注解是“属于"类的代码.请参阅官方文档中的javadoc 示例. ..
发布时间：2021-11-10 22:07:17 Java开发

javadoc @hide无法正常工作

根据链接，我写道以下代码: /*** @隐藏* */公共无效myMethod(){//做一点事} 当我使用命令生成文档时: $ javadoc -locale en_US -encoding UTF-8 -charset UTF-8 -d doc xxx.java 该文档仍然具有 myMethod 项目.那么如何隐藏 myMethod ?我想念什么? 解决方案 您正在使用 D ..
发布时间：2021-05-19 18:36:35 Java开发