私有(private)方法的 JAVADOC (BlueJ)

Question

我正在使用 BlueJ，我想生成整个项目的 Javadoc。 我想在 Javadoc 上显示私有(private)方法，有什么办法吗？ BlueJ 有一个制作 Javadoc 的工具，但 BlueJ 忽略私有(private)方法。 只是一个约定？如果这是约定俗成，我不明白为什么，他们忽略了“内部”方法，它们也很有用-.-*

Answer 1

This link建议 BlueJ 只会为公共(public)方法和类生成 JavaDoc。 具体来说:

your output will only contain information about public methods and variables

然而，根据这个bug report链接到 Andrew Thompson's answer ，这似乎已在 BlueJ 的 1.1.5 版中得到修复。事实上，根据 BlueJ Reference Manual 的第 9.8 节，您可以通过编辑 doctool.options 属性，准确地指定在运行 JavaDoc 工具时要使用的选项。

似乎有 3 个属性控制文档生成的行为:

• doctool.command:控制使用什么命令生成文档，默认设置为javadoc
• doctool.outputdir:控制生成文档的保存位置，默认设置为doc
• doctool.options:控制传递给javadoc.command指定命令的其他命令行选项，默认设置为-author –version – nodeprecated –package.请注意，通过将 -package 替换为 -private，您可以记录所有方法。

一般来说，由于 JavaDoc 工具是一个命令行程序，您可以简单地从命令行自己调用它，如下所示:

$ javadoc -d \path\to\output\folder -sourcepath \path\to\source\folder -private

请注意，此命令假定 javadoc 包含在您的 PATH 环境变量中，大多数 java 安装通常都是这种情况。

• -d 选项给出所需的输出目录
• -sourcepath 选项告诉 JavaDoc 工具在哪里可以找到要记录的源代码
• -private 选项告诉 JavaDoc 工具为所有类、成员和方法创建文档(因为私有(private)是最受限制的可见性)

控制 JavaDoc 将记录的成员的完整选项列表是:

• -public - 仅显示公共(public)类和成员。
• -protected - 仅显示 protected 和公共(public)类和成员。这是默认设置。
• -package - 仅显示包、 protected 和公共(public)类和成员。
• -private - 显示所有类和成员。

(取自 JavaDoc Documentation)

编辑 0: 更新了答案以纳入 Andrew Thompson 揭示的新信息