Java Javadoc 包括 Private

Posted

技术标签:

【中文标题】Java Javadoc 包括 Private【英文标题】:Java Javadoc include Private 【发布时间】:2011-03-07 07:00:37 【问题描述】:

我想为我的应用程序生成 javadocs,并且我还想包含私有成员。

我在Javadoc documentation找到了以下内容

 -私人
           显示所有类和成员。

你能帮我举一个执行的例子吗?

应该类似于:javadoc -private ...。我需要知道如何为生成的 html doc 文件提供根目录和目标目录。

谢谢。

编辑: 我找到了一种从 NetBeans 6.8 生成 javadoc 的方法。如下:

NetBeans Java 项目通常在项目的属性部分为此提供一个参数。您可以在“项目”窗口中右键单击项目名称并选择“属性”。在出现的 Project Properties 窗口中,Documenting 节点包含一个标记为“Include Private and Package Private Members”的复选框字段。

我发现了这个here

似乎可以根据需要生成文档。谢谢大家。

【问题讨论】:

【参考方案1】:

从命令行,它说

javadoc [options] [packagenames] [sourcefiles] [@files]

所以它会是这样的:

javadoc -private -d output/directory -sourcepath src/java

但你也可以看看javadoc documentation 和这个section。

【讨论】:

【参考方案2】:

你看过手册页吗?

https://docs.oracle.com/javase/1.5.0/docs/tooldocs/solaris/javadoc.html

它包含一段简单的例子。

试试这个

javadoc -private -d /home/html -sourcepath /home/src

【讨论】:

以上是关于Java Javadoc 包括 Private的主要内容,如果未能解决你的问题,请参考以下文章

阿里巴巴Java开发手册-注释规约

阿里巴巴Java 开发手册编程规约之注释规约

java元注解 @Documented注解使用

java 生成javadoc文档,怎么总报错

eclipse怎样生成javadoc

javadoc:错误 - java.lang.OutOfMemoryError