将示例用法(markdown吗?)添加到JavaDocs

时间:2019-02-17 23:01:29

标签: html markdown javadoc maven-javadoc-plugin

说我有这个:

enter image description here

是否有一种向每个方法添加markdown或html的方法,并提供了如何使用该方法的示例?我在考虑一个扩展面板-按钮显示视图示例,它会打开一个面板。

我尝试将其添加到嵌入式文档中

 /**
   * <pre>
   * <code>new BeanTranslator.Builder()
   *   .translate(
   *     new{@code Translator<String, Integer>}(String.class, Integer.class){
   *      {@literal @}Override
   *       public Integer translate(String instance) {
   *         return Integer.valueOf(instance);
   *       }})
   *   .build();
   * </code>
   * </pre>
   */
  @SuppressWarnings("Duplicates")
  public static <I, T, V, E> void Reduce(I initialVal, List<T> tasks, Asyncc.Reducer<V, E> m, Asyncc.IAsyncCallback<V, E> f) {
    NeoReduce.Reduce(initialVal, tasks, m, f);
  }

但是我只在右侧看到它:

enter image description here

1 个答案:

答案 0 :(得分:1)

有一个library允许在Javadocs中使用Markdown甚至是PlantUML,如下所示:

/**
* Java Example:
*
* ```java
* @Override
* public void myMethod() {
* }
* ```
*/