私有方法的JAVADOC(BlueJ)

发布时间：2020-12-14 05:48:13 所属栏目：Java 来源：网络整理

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

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

解决方法

This link表明BlueJ只会为公共方法和类生成JavaDoc.
特别：

your output will only contain information about public methods and variables

但是,根据与Andrew Thompson’s answer相关联的bug report,看起来这已经在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.请注意,通过使用-private替换-package,您可以记录所有方法.

通常,由于JavaDoc工具是一个命令行程序,您可以从命令行自己调用它,如下所示：

$javadoc -d pathtooutputfolder -sourcepath pathtosourcefolder -private

注意,此命令假定javadoc包含在PATH环境变量中,这在大多数Java安装中通常都是这种情况.

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

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

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

(摘自JavaDoc Documentation)

编辑0：
更新了答案,纳入了Andrew Thompson年曝光的新信息

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!