IntelliJ：将方法名称和签名提取到文本文件中

Question

我想为我一直在编写的课程编写一些外部文档。我想给出一个可用方法的简明列表，基本上对应于 IntelliJ 给出的“结构”视图。我什至可以从视图中复制和粘贴，但是只会复制方法名称而没有方法签名或返回值。

有没有什么快速的方法可以从 IntelliJ 中创建用于文档目的的类的结构概览？

谢谢！

编辑：看来我还没有完全说清楚，对此我深表歉意。具体来说，我想记录以下课程：https://github.com/JULIELab/jcore-base/blob/2.3.0-SNAPSHOT/jcore-utilities/src/main/java/de/julielab/jcore/utility/JCoReAnnotationTools.java

我寻求的输出格式是一个文本文件，应该如下所示：

这是来自 IntelliJ 的“结构”面板的屏幕截图，@Tiru 也指出了这一点。以纯文本形式获取此确切信息的最简单方法是什么？

JavaDoc 是一种可能性，但相比之下相当冗长，需要相当多的后处理。由于 IntelliJ 已经在创建这种简洁的概述，我希望有可能将其提取为文本。

Answer 1

您可以通过反射自己做到这一点。我做了一个小小的开始。将其写入文件很容易。我将把它作为练习留给读者。

import java.lang.reflect.Method;
import java.util.Arrays;
import java.util.stream.Collectors;

class Scratch {
    public static void main(String[] args) {
        StringBuilder stringMethods = findMethods(String.class);
        System.out.println(stringMethods);
    }

    private static StringBuilder findMethods(Class clas) {
        StringBuilder builder = new StringBuilder();

        Method[] methods = clas.getMethods();
        for (Method method : methods) {
            builder.append(" ")
                   .append(method.getName())
                   .append("(");

            Class<?>[] parameterTypes = method.getParameterTypes();
            for (int i = 0; i < parameterTypes.length; i++) {
                Class<?> aClass = parameterTypes[i];
                builder.append(aClass.getSimpleName());
                if (i < parameterTypes.length - 1) {
                    builder.append(", ");
                }
            }

            builder.append(")");

            builder.append(": ")
                   .append(method.getReturnType().equals(Void.class) ? "void" : method.getReturnType().getSimpleName())
                   .append(" ");

            if (method.getExceptionTypes().length > 0) {
                builder.append(" throws ")
                       .append(Arrays.stream(method.getExceptionTypes()).map(Class::getSimpleName).collect(Collectors.joining(", ")));
            }

            builder.append(System.lineSeparator());

        }
        return builder;

    }

}

Answer 2

是的，您可以使用快捷方式 (cmd + F12 / ctrl + F12) 轻松获取方法列表。这将为您提供方法和类变量的列表。您可以在文档中选择并使用它。

例如：

另一种方法是通过侧窗格中的结构：

或通过图表：

示例图：

Answer 3

我不想成为不得不说这个的人，但是......

Javadoc 是唯一可移植的东西，可以可靠地生成您正在寻找的东西。

要注意的重要一点是，您必须自己编写任何 Javadoc。你可以invoke the tool 它会生成你想要的。

在较新版本的 Java 中，生成的 Javadoc 也是可搜索的。