【问题标题】:Generate Javadoc for interfaces only?仅为接口生成 Javadoc?
【发布时间】:2010-05-06 02:39:25
【问题描述】:

我正在寻找一种方法来编写一个脚本,我可以只为我的程序接口(不适用于公共类)生成 javadoc。我尝试过 Eclipse 内置工具甚至 JAutodoc 工具,但还没有成功。

请问有人有什么想法吗?

谢谢。

【问题讨论】:

    标签: java doc


    【解决方案1】:

    就个人而言,我会使用自定义 ant 脚本(如果您熟悉的话)。使用 javadoc 任务,您可以将嵌套的“文件集”元素与动态生成的接口列表一起使用。或者只是有脚本将所有接口复制到临时目录,运行 javadoc 并最后删除 temp dir。 last 甚至可以用 bash 脚本来实现。

    但是,如果您希望用户看不到您的实现类,那么限制它们的可见性会更有意义。然后您可以仅为公共条目生成文档。只是一个想法。

    【讨论】:

    • 我知道如何使用 Ant 任务生成 javadoc。但是,我不知道如何检查文件是否是 Ant 脚本中的接口。我的程序有数百个类和接口,困难在于接口本身并不位于单独的文件夹中。如果接口位于单独的文件夹中,我会很容易。你知道如何在 Ant 脚本中检查文件作为类或接口吗?谢谢
    • 这个想法是循环浏览它们(ant-contrib 让你这样做)寻找模式。虽然,使用 bash 脚本和将接口复制到临时文件夹的想法似乎更容易。
    猜你喜欢
    • 1970-01-01
    • 2013-06-07
    • 1970-01-01
    • 2015-07-26
    • 1970-01-01
    • 2016-09-19
    • 2011-03-11
    • 2013-10-26
    • 1970-01-01
    相关资源
    最近更新 更多