私有方法的JAVADOC(BlueJ)

Question

我正在使用BlueJ,我想生成整个项目的Javadoc.我想在Javadoc上显示私有方法,有什么方法可以做到吗？BlueJ有一个生成Javadoc的工具,但BlueJ忽略了私有方法.只是一个惯例？如果这是一个惯例,我不明白为什么,他们忽略"内部"方法,它们也是有用的.--*

Answer 1

此链接表明BlueJ将仅为公共方法和类生成JavaDoc.特别:

您的输出将仅包含有关公共方法和变量的信息

但是,根据安德鲁汤普森答案中链接的这个错误报告,它似乎已在BlueJ的1.1.5版本中得到修复.实际上,根据BlueJ参考手册的第9.8节,您可以通过编辑属性来准确指定运行JavaDoc工具时要使用的选项.doctool.options

似乎有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工具为所有类,成员和方法创建文档(因为私有是最受限制的可见性)

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

• -public - 仅显示公共课程和成员.
• -protected - 仅显示受保护的公共类和成员.这是默认值.
• -package - 仅显示包,受保护和公共类和成员.
• -private - 显示所有类和成员.

(摘自JavaDoc文档)

编辑0: 更新了答案,结合Andrew Thompson揭示的新信息