我如何排除的Javadoc Ant任务结果的具体方法/构造？ [英] How do I exclude a specific method/constructor from the results of the javadoc Ant task?

问题描述

我使用的是由的javadoc Ant任务来记录Web服务产生的javadoc，我要排除从输出部分构造。我该怎么做呢？

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。程序员
  将标志着一类，接口，
  构造函数，方法或字段
  @排除。标签presence将导致
  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屋！