如何避免使用不同参数的相同方法重复的java doc

时间:2016-11-07 01:33:18

标签: java javadoc

标题为

。我知道我们可以使用@see或@link,但是如果有任何标准方法可以避免它。 示例:两种方法仅在一个参数上有所不同。

 /**
   * Enable Batching of single Point writes to speed up writes significant. If either actions or
   * flushDurations is reached first, a batchwrite is issued.
   * Note that batch processing needs to be explicitly stopped before the application is shutdown.
   * To do so call disableBatch().
   *
   * @param actions
   *            the number of actions to collect
   * @param flushDuration
   *            the time to wait at most.
   * @param flushDurationTimeUnit
   * @return the InfluxDB instance to be able to use it in a fluent manner.
   */
  public InfluxDB enableBatch(final int actions, final int flushDuration, final TimeUnit flushDurationTimeUnit);

  /**
   * Enable Batching of single Point writes to speed up writes significant. If either actions or
   * flushDurations is reached first, a batchwrite is issued.
   * Note that batch processing needs to be explicitly stopped before the application is shutdown.
   * To do so call disableBatch().
   *
   * @param actions
   *            the number of actions to collect
   * @param flushDuration
   *            the time to wait at most.
   * @param flushDurationTimeUnit
   * @param threadFactory
   * @return the InfluxDB instance to be able to use it in a fluent manner.
   */
  public InfluxDB enableBatch(final int actions, final int flushDuration, final TimeUnit flushDurationTimeUnit,
                              final ThreadFactory threadFactory);

0 个答案:

没有答案