如何从 javadoc Ant 任务的结果中排除特定的方法/构造函数? [英] How do I exclude a specific method/constructor from the results of the javadoc Ant task?

问题描述

我正在使用由 javadoc Ant 任务生成的 javadoc 来记录 Web 服务，并且我想从输出中排除一些构造函数.我该怎么做?

I'm using javadocs generated by the javadoc Ant task to document a web service, and I want to exclude some constructors from the output. How do I do that?

推荐答案

对于公共方法没有办法做到这一点.标准做法(即使在相当多的 JDK 类中)是表明该方法或构造函数不适合公共使用.

There is no way to do this for public methods. The standard practice (even in quite a few JDK classes) is to indicate that the method or constructor is not meant for public use.

有一个 计划添加@exclude 标签未来:

@exclude - 用于排除的 API由 Javadoc 生成.程序员将标记一个类、接口、构造函数、方法或字段@排除.标签的存在会导致要从生成的 API 中排除文档.文本跟随标签可以解释排除的原因，但会被 Javadoc 忽略.(以前提议为@hide，但隐藏"一词更适合于运行时动态显示/隐藏能力.)有关更多讨论，请参阅:开发人员中的 功能请求 #4058216连接.

@exclude - for API to be excluded from generation by Javadoc. Programmer would mark a class, interface, constructor, method or field with @exclude. Presence of tag would cause API to be excluded from the generated documentation. Text following tag could explain reason for exclusion, but would be ignored by Javadoc. (Formerly proposed as @hide, but the term "hide" is more appropriate for run-time dynamic show/hide capability.) For more discussion, see: Feature Request #4058216 in Developer Connection.

这篇关于如何从 javadoc Ant 任务的结果中排除特定的方法/构造函数?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！