问题标签 [javadoc]

是否有理由将两者都包括在内@version并@since作为课程的一部分？

它们似乎是相互排斥的。

另外，是什么意思，%I%以及%G% 如何设置/使用它们？

我创建了 java api - 从 C# 移植到更具体的 - 除了公共接口之外，它还包含许多我不希望用户知道的内部内容。在 C# 中，我使用 doxygen 来生成文档。我认为 javadoc 具有类似的功能来排除某些公共成员、类，甚至包。

有人会建议如何做到这一点，也许是通过日食？

谢谢

好吧，让我们离开友谊是否打破封装的争论，并实际尝试优雅地提出一个连贯的设计。这是一个双重功能：

1）关于如何实施的一般问题：

2) 为什么我需要这个功能？我的一些类实现了 Serializable 接口。但是，我想在 Derived 类中保护 Serializable 方法，这样我就不会将它们暴露给客户端（以及文档——javadoc）。但是，内部类应该能够访问它们。在java中解决这个问题的一般方法是什么？

注意：我使用当前 C++ 标准中定义的友谊。

谢谢

我被一个遗留的 Java 代码库困住了，当你编译它时，它有成千上万的警告。我很想真正解决所有这些警告的来源，但不幸的是，目前在我的公司这不是一个选择（其他事情，比如“制造产生收入的新产品”被负责人认为是更高的优先级；想象一下） .

现在，我可以忍受所有这些警告，如果不是因为它们很难在我们的连续构建服务器的输出中找到实际错误。构建服务器只使用了一个 ant 调用，没什么特别的，但到目前为止，我还没有在任何地方找到任何关于如何修改这个调用以防止警告输出的东西。

浏览代码并在各处添加@SuppressWarnings 注释会起作用，但它也几乎与浏览并修复所有警告的来源一样痛苦。所以我真正喜欢的是，如果我能做一些事情：

或类似的东西，使 javadoc 编译器不输出所有警告消息。这样的事情（全局javadoc警告禁用）可能吗？

在 Java API 中，我可以看到包的 Javadoc 注释。

如何/在哪里放置 Javadoc 注释来记录包？

在使用 C++ 编程时，我使用 Doxygen 并经常为不适合特定类或方法的其他文档创建外部 .dox 文件 - 例如，文件格式文档（用于由多个类访问的文件）。我试图找到一种在 Java 中做同样事情的方法，但似乎 javadoc 没有等效的功能，所有文档都必须写在 .java 文件的注释中并与之相关联（或至少与其相关联）包裹）。我对吗？有没有其他方法可以做到这一点？

如何从类中检索不推荐使用的方法列表。

我需要列出已标记为已弃用的方法，以便将类传递给文档。

我真的不想将每个方法及其 javadoc 复制并粘贴到单独的文件中，是否可以通过 javadoc 工具或通过 eclipse 来做到这一点？

我需要包含*/在我的 JavaDoc 注释中。问题是这也是关闭评论的相同顺序。引用/逃避这个的正确方法是什么？

例子：

跟进：看来我可以使用/斜线。唯一的缺点是直接在文本编辑器中查看代码时，这并不是那么可读。

"${person}" 部分破坏了文档注释，因为它使用了花括号。

javadoc是否可以捕获通过Ant 任务运行时 Javadoc 打印的警告？我没有看到任务中的输出属性。似乎有警告说 Checkstyle 没有捕捉到，最好在文件中捕获该输出。

似乎很奇怪，这将无法捕获，希望我遗漏了一些明显的东西。

~*~*~*~编辑（下面的答案）~*~*~*~

看来 Ant <record> 任务正是我想要的。请参阅Ant 文档。