有没有办法为公共方法的子集生成 Javadoc?例如,将公共方法注释为“不属于公共 API 的一部分”

2023-11-22

我知道如何为类/接口/包的子集生成 Javadoc。但是有没有办法只为公共方法的子集生成 Javadoc?

我更希望能够将方法(Javadoc 标记或注释)标记为属于某个 API 或不属于该 API。然后拥有一个工具,仅为指定的一组方法(形成 API 的方法)生成 Javadoc。

对方法的公共/私有/包访问之间的选择对于我的项目来说是不够的。公共方法可能属于公共 API,也可能不属于公共 API,也可能属于 API 1,但不属于 API 2。本质上,我希望能够从公共方法的任意子集中选择 API。


如果您正在使用javadoc命令行工具,您可以通过将公共方法标记为来排除它们Deprecated并使用-nodeprecated选项。但如果你想要更复杂的东西,你就必须自己实现。

关于如何做到这一点的粗略想法:

  1. 创建自定义注释@API1、@API2等。
  2. 使用这些注释对您的方法进行分类(即标记它们)
  3. 编写一个自定义 Ant 任务,该任务读取一个配置参数(例如,从文件中),该参数告诉您要为其生成 Javadoc 的 API。
  4. 仍然在 Ant 任务中,循环遍历带注释的方法,并将所有不是所选 API 的 API 注释替换为 Deprecated 注释。这会将它们从 Javadoc 中排除。

恕我直言,这很麻烦。就像他们在评论中所说的那样,如果您有一个具有多个接口的类(我猜是针对不同的用户配置文件?),请考虑编写单独的接口。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

有没有办法为公共方法的子集生成 Javadoc?例如,将公共方法注释为“不属于公共 API 的一部分” 的相关文章

随机推荐