我想在 Javadoc上显示私有方法,有什么方法可以做到吗?
BlueJ有一个生成Javadoc的工具,但BlueJ忽略了私有方法.
只是一个惯例?如果这是一个惯例,我不明白为什么,他们忽略“内部”方法,它们也是有用的.– *
解决方法
特别:
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工具时要使用的选项.
> doctool.command:控制用于生成文档的命令,默认情况下设置为javadoc
> doctool.outputdir:控制保存生成文档的位置,默认情况下设置为doc
> doctool.options:控制传递给javadoc.command指定的命令的其他命令行选项,默认设置为-author -version -nodeprecated -package.请注意,通过使用-private替换-package,您可以记录所有方法.
通常,由于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 – 显示所有类和成员.
编辑0:
更新了答案,纳入了Andrew Thompson年曝光的新信息
原文地址:https://www.jb51.cc/java/121243.html
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。