Questions tagged «javadoc»

使用JavaDoc，如何在类中引用最终静态字段的值？ 我希望???在此示例中将其替换为field的值STATIC_FIELD。 /** * This is a simple class with only one static field with the value ???. */ public class Simple { /** * We can reference the value with {@value} here, * but how do we reference it in the class JavaDoc? */ public static final String STATIC_FIELD …

96 java  documentation  javadoc 

在为仅包含属性以及getter和setter（DTO风格）的“简单” POJO类的属性/成员编写Javadoc时，经常会遇到两难境地。 1）为属性写Javadoc 或... 2）为getter写Javadoc 如果我为该属性编写javadoc，那么当我稍后通过代码完成访问POJO时，我的IDE（Eclipse）自然将无法显示此内容。而且没有标准的javadoc标记可让我将getter-javadoc链接到实际属性javadoc。 一个例子： public class SomeDomainClass { /** * The name of bla bla bla */ private String name; /** * @return INSERT SOME SMART JAVADOC TAG LINKING TO name's javadoc */ public String getName() { return name; } 因此，基本上，听到其他人如何使Eclipse IDE显示您的吸气剂的javadoc属性描述会很有趣-无需重复javadoc注释。 到目前为止，我正在考虑使我的实践仅记录吸气剂，而不记录属性。但这似乎不是最好的解决方案...

93 java  javadoc 

我正在从Eclipse迁移到Intellij Idea。我还不知道的一件事是@authorJavaDoc标签的自动补全。@a在Eclipse中键入内容时，有两个建议： @author - author name @author 如何实现Intellij中的第一个建议（甚至有可能？）？并且，如果可能的话，如何更改作者姓名占位符插入模板？

92 intellij-idea  javadoc 

我查看了JavaDoc参考，并且虽然了解了@see（各种链接）和{@inheritDoc}（超类JavaDoc注释的导出）之间的基本区别，但是我需要澄清事情的实际实现方式。 在Eclipse IDE中，当我为继承的方法（从接口或toString（）重写，等等）选择“生成元素注释”时，它将创建以下注释 /* (non-Javadoc) * @see SomeClass#someMethod() */ 如果需要生成JavaDoc，我应该保留它，替换@see为{@inheritDoc}，或将其变成真正的JavaDoc，例如： /** * {@inheritDoc} */ 当我这样做时，是否仍应保留class＃method标志？

87 java  javadoc  comments 

假设，在记录代码（Javadoc）的过程中，您希望使用深度缩进来指示元素之间的关系。 如何创建嵌套列表为： 一些要素 其他要素 还有其他一些要素

86 documentation  javadoc  indentation  nested-lists 

我正在为包含它自己的枚举的类编写javadoc。有没有一种方法可以为单个枚举生成javadoc？例如，现在我有这样的东西： /** * This documents "HairColor" */ private static enum HairColor { BLACK, BLONDE, BROWN, OTHER, RED }; 但是，这仅记录了所有枚举的整体： 有没有办法单独记录每个HairColor值？无需将枚举移入自己的类或从枚举更改它？ 在此先感谢您的帮助。

83 java  enums  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 …

81 java  javadoc 

当我将鼠标悬停在类上时，我想让jar文件中包含的javadoc注释在eclipse中显示。 例如，下载JODA-2.0后，将获得三个jar： 乔达时间2.0 joda-time-2.0-javadoc joda-time-2.0-sources（http://sourceforge.net/projects/joda-time/files/joda-time/2.0/joda-time-2.0-dist.zip/download） 在eclipse中，[右键单击项目->属性-> Java Build Path->库-> ADD JARs ...]在项目中可以引用joda-time-2.0.jar的二进制文件（可以引用这些类）。 但是，如何链接其他两个jar文件中包含的source / javadoc注释，以便当我将鼠标悬停在这些类上时可以看到javadocs？ 将其他两个jar（joda-time-2.0-javadoc.jar和joda-time-2.0-sources.jar）添加到构建路径不会链接javadocs或源。

80 java  eclipse  jar  javadoc 

关闭。此问题不符合堆栈溢出准则。它当前不接受答案。 想改善这个问题吗？更新问题，使其成为Stack Overflow的主题。 6年前关闭。 改善这个问题 让我们面对现实：您无需成为设计师即可看到默认的Javadoc看上去很丑陋。 网络上有一些资源提供了重新样式化的Javadoc。但是默认行为代表了产品，并且应该看起来相当合理。 另一个问题是，与其他类似资源相比，Javadoc的可用性不是最新的。 大型项目很难使用Firefox的快速搜索进行导航。 实际问题： 是否有任何独立（桌面）应用程序能够以比浏览器更有用的方式浏览现有Javadoc？ 我正在考虑诸如Mono文档浏览器之类的东西。 理论上的问题： 是否有人知道，如果有计划以某种标准化的方式发展Javadoc？ 编辑： 有关此主题的Sun Wiki的有用链接。

80 java  documentation  javadoc 

对不起，可能是常见问题，但我只是找不到答案。 据我所记得的Eclipse，Javadoc注释中的空白行显示为（在源Javadoc弹出窗口中）作为换行符（具有额外的垂直间距）。 但是，在Netbeans中并非如此。 我可以配置Javadoc将空白行解释为换行符吗？ 附加问题：我可以为源Javadoc弹出窗口覆盖默认的Netbeans行为（与此相关）吗？ 我在说的是： 资源 /** * Paragraph One * * Paragraph Two */ void someMethod() { } Eclipse解释 Paragraph One Paragraph Two Netbeans解释 Paragraph One Paragraph Two

80 java  netbeans  comments  javadoc 

目前，我正在使用JavaFX。每当我将鼠标悬停在JavaFX方法上时，它都会给我以下错误： 'Note: This element neither has attached source nor attached Javadoc and hence no Javadoc could be found' 我该如何解决？如何附加javadoc或源代码，以便可以看到方法的描述？

79 java  eclipse  javadoc  javafx-2 

目前，有两种方法可以将代码标记为Java中已弃用的代码。 通过JavaDoc /** * @deprecated */ 或作为注释： @Deprecated 这是我的问题-在使用Eclipse将方法标记为不推荐使用时，要声明两者都太多了。我真的只想使用其中之一。 但是，使用注释是否会为编译器提供实际有用的其他信息？ 但是，仅使用注释，就无法说明为什么不赞成使用该方法-我只能使用JavaDoc来做到这一点，并且不赞成说明为什么不赞成使用不赞成使用的方法。 因此，我只能使用其中之一吗？或者我真的应该学会同时指定两者吗？

78 java  annotations  javadoc  deprecated 

我想为我正在使用的开源代码库生成javadocs。但是Eclipse Generate JavaDoc向导要求我提供“ Javadoc命令”，并且该帮助未解释这意味着什么。是否需要javadoc binary / jar或其他路径？

72 java  eclipse  javadoc 

关闭。此问题不符合堆栈溢出准则。它当前不接受答案。 想改善这个问题吗？更新问题，使其成为Stack Overflow的主题。 3年前关闭。 改善这个问题 我只知道如何在网站上在线阅读Javadoc，但是当网络不可用时，我想下载它以供离线阅读。 如何下载文档？

71 javadoc 

Exit code: 1 - javadoc: error - The code being documented uses packages in the unnamed module, but the packages defined in https://docs.oracle.com/en/java/javase/11/docs/api/ are in named modules. 有没有人能够使javadoc工作而不必将源版本更改为1.8（如其他论坛中所建议）？我使用的是JDK v11.0.5，问题仍然存在（JDK 12+也是如此）。 编辑：此错误源于maven，由maven-javadoc-plugin抛出。即使进行了<source>8</source>配置，我也无法使它适用于JDK 11+ 。

13 java  maven  javadoc  java-11  maven-javadoc-plugin