Tag: javadoc

Java LinkedList – 检索操作之间的差异: LinkedList以下每组元素检索操作中的不同方法之间是否存在任何差异？返回null +删除操作： poll() ， pollFirst() 。返回null +不删除操作： peek() ， peekFirst() 。抛出exception+删除操作： pop() ， remove() ， removeFirst() 。抛出exception+不删除操作： element() ， getFirst() 。插入方法中存在类似的重复。如果没有这样的差异，我希望在方法的javadoc中提到它（类似于旧的“这就像调用……”）。它只是一个草率的文件，还是我错过了什么？

JavaDoc可重用参数值: 好吧，我这里有这个代码，这是我对标准Swing TableModel的替代实现。我认为这是一个绝对的噩梦，我的问题是，我有很多rowIndex和columIndex参数，有没有一种方法可以在它们之间共享描述，以实现更标准化，更少的手指工作方式？谢谢！！ package atablemodel; import java.util.ArrayList; import javax.swing.table.AbstractTableModel; import javax.swing.table.TableModel; /** * My custom swing TableModel version 1.x will represent a complete table model * while version 2.x adds several methods for updating an existing table version * 0.x is an incomplete version * Completely changed everything to work with arraylist instead of […]

“可选操作”在Javadoc中的含义是什么，例如Set＃add（E）？: 在用于Set的java文档中时，它在方法规范中说明Optional Operation例如（我强调）添加（E e）如果指定的元素尚不存在，则将其添加到此集合（可选操作）。可选的含义是什么？如果我使用除SUN / Oracle之外的JVM，Java的实现可能无法提供此操作？

UmlGraph vs APIViz for Maven javadoc generation: 我想知道是否有任何明确的理由选择UmlGraph而不是APIViz来生成Maven2构建中的javadoc UML图。是否有任何集成或function，但它们看起来非常相似？

有没有办法让javadoc工具记录注释？: 在我的项目中，我们使用了许多注释，这些注释在javadoc API文档中非常有用。有没有人知道在生成的javadocs中包含注释的简单方法？我不想编写自己的javadoc插件。那里有解决方案吗？

inheritancejavadoc，而不为inheritance的源生成文档: 我希望class B从它实现的接口inheritanceJavadoc， interface A 我在Javadoc命令中包含了interface A的源代码，而class B正确地inheritance了文档。现在我想知道我是否可以将它生成的链接指向网络上的interface A的文档，而不是在我的网站上复制它，即“指定者：”链接将链接到外部页面。这可能吗？

如何使Ant Javadoc类排除两个文件？: 我正在记录一些Java Web服务和支持数据类型。我不想记录两种服务。从Ant javadoc任务中排除少量文件的正确方法是什么？我已尝试使用嵌套在sourcepath或sourcefiles下的文件或文件集进行多次迭代，并使用include和exclude的各种组合。我已正确定义的基本目标记录了我的所有Web服务： <![CDATA[company project Webservices]]> <![CDATA[Copyright © 2011 company Corp. All Rights Reserved.]]> 我尝试过的一些变化包括：此错误与javadoc.exe CreateProcess error=87, The parameter is incorrect 与sourcefiles相同的错误，但有很多消息说skipping since it is no directory 。我使用而不是尝试了类似的变体。我想我错过了一些关于如何包含/排除作品的基本理解。感谢您的帮助！ AlexR并没有得到它，但接近了。我删除了并添加了只有一个文件集导致javadoc抱怨它找不到任何包。 Packageset的行为类似于dirset，因此它不能排除单个文件，只能排除目录。在这种情况下，我能够为一组doco定义一个包集，并为限制集定义一个文件集并绕过它。

将API代码与类一起放入JAR有什么不利之处吗？: 在Java中，如果将源代码（ .java）文件与类（ .class）一起打包到jar中，大多数IDE都会像eclipse一样显示代码完成的javadoc注释。 IIRC很少有像JMock这样的开源项目。让我说我已经干净地将我的API代码与实现代码分开，以便我有类似myproject-api.jar和myproject-impl.jar的东西有什么理由我不应该把源代码放在我的myproject-api.jar中？因为性能？尺寸？为什么其他项目不这样做？编辑：除了Maven下载问题，将我的源代码放入类jar以支持尽可能多的开发人员（maven与否）会有什么损害吗？

如何从JavaDoc生成PDF（包括概述和包概述）: 我在我的应用程序上编写了大量的JavaDoc文档，并在overview.html和package.html文件中添加了许多有用的信息（包括前者的链接到doc-files/插图）。 Maven的Javadoc插件很好地使用标准的javadoc工具来生成经典的JavaDoc框架集，但现在我需要使用整个文档生成PDF。 AurigaDoclet生成非常漂亮的PDF，我也能够使DocFlex工作。但是，两者都忽略了我的overview.html和package.html文件（在Maven内外尝试过 – PDF将是一次性的事情，因为从长远来看，我宁愿拥有HTML）。有谁知道如何使AurigaDoclet识别我的非Java文件？或者，另一种是从源代码或JavaDoc生成的HTML生成外观漂亮的PDF？谢谢！