首页 > 解决方案 > 将示例用法(降价?)添加到 JavaDocs

问题描述

说我有这个:

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

标签: htmlmarkdownjavadocmaven-javadoc-plugin

解决方案


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

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

推荐阅读