【问题标题】:Javadoc only one class in a package using AntJavadoc 只有一个使用 Ant 的包中的一个类
【发布时间】:2009-01-30 19:31:18
【问题描述】:

我正在使用 apache ant 为我的项目生成 javadoc。我的一个包中有很多类,我只想展示一个。我该怎么做呢?这是我当前的代码。

<javadoc
    sourcepath="jig-engine/src"
    destdir="${target.path}/docs/javadoc/"
    packagenames="jig.engine.util.Vector2D" >
</javadoc>

(为清楚起见进行了简化)

【问题讨论】:

  • 如果类是私有的,则不会生成文档。我问你为什么不想为这些类生成文档?如果是因为您不希望人们访问它们,请将它们设置为受保护或私有或更改它们的访问方式。默默无闻的安全不起作用。
  • +1 给 Malfist;我想不出在什么情况下限制 Javadocs 是解决问题的最佳方法(至少根据我的经验)。
  • 如果您正在为刚开始学习 Java 的学生制作课程,并且不希望他们被作业中不需要的课程所迷惑?

标签: java javadoc ant


【解决方案1】:

使用 sourcefiles 参数代替 sourcepath:

<javadoc
    sourcefiles="jig-engine/src/path/to/your/file.java"
    destdir="${target.path}/docs/javadoc/">
</javadoc>

【讨论】:

  • 这仅适用于 file.java 不依赖于其他文件的情况。我尝试了这个并得到了 javadoc 错误,因为 file.java 引用了未列出的不同文件中的代码。有没有办法让 javadoc 查看多个文件,但只为其中一个生成代码(不限制其他类的可见性)?
猜你喜欢
  • 2012-07-12
  • 2011-11-09
  • 2011-04-14
  • 2014-06-23
  • 1970-01-01
  • 1970-01-01
  • 2016-04-28
  • 2014-08-09
  • 1970-01-01
相关资源
最近更新 更多