html - 将示例用法(降价?)添加到 JavaDocs
问题描述
说我有这个:
有没有办法为每个方法添加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);
}
但我只在右侧看到这个:
解决方案
有一个库允许在 Javadocs 中使用 Markdown 甚至 PlantUML,如下所示:
/**
* Java Example:
*
* ```java
* @Override
* public void myMethod() {
* }
* ```
*/
推荐阅读
- python - 如何从python中的数组中获取匹配的记录?
- python - 使用 Python 将两个 JSON 合二为一
- ios - 如何在视图上添加方形渐变边框 - ios
- bash - 使用 sed 从多个文件中替换文件路径名
- android - Android Studio 3.1.3 路径错误
- php - codeigniter 表单从引导表单接收空白电子邮件
- html - 需要搜索列表作为 ionic 3 中的弹出框
- javascript - select2选项空间未搜索
- java - 如何在基于spring注解的项目中提供数据源入口。
- javascript - 如何安全地访问 firebase 数据以自动填充网页?