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

标签 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

最佳答案

有一个library允许像这样在 Javadocs 中使用 Markdown 甚至 PlantUML:

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

关于html - 将示例用法(markdown?)添加到 JavaDocs,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/54738479/

相关文章:

ruby-on-rails - 测试 Redcarpet Markdown 助手

用于显示另一种方法的文档的 Javadoc 标记

java - Maven javadoc 搜索重定向到 "/undefined/.."url

python - 如何使用 cgi python 脚本在浏览器中显示 pdf 文件内容及其全名?

jquery - 为什么 !document.body 返回 False?

html - CSS 背景渐变,图像

reactjs - 使用 Gatsby 将 Rich-Text 组件中的 Markdown 转换为 HTML

github - 从 Github-Issue 嵌入图像中获取引荐来源网址

java - 如何在 Eclipse 中查看 Javadoc?

html - 更改与实际选项文本不同的下拉选择文本