生成自定义 javadoc 时遇到问题;"找不到文档"

Question

我正在尝试使用Doclet创建自定义Javadoc生成器，但是我遇到了一些问题。

我正在遵循官方文档，最初在将tools.jar文件包含在我的项目中时遇到了麻烦，但我设法解决了这个问题。

我现在的问题是运行此命令后...

javadoc -doclet ListClass -docletpath .  MyClass.java

。我收到消息...

javadoc： error - 找不到 doclet 类 ListClass

正如我所说，我主要遵循官方文档中的教程，但这是我的代码以供参考。

ListClass.java ：

import com.sun.javadoc.*;
public class ListClass {
    public static boolean start(RootDoc root) {
        ClassDoc[] classes = root.classes();
        for (int i = 0; i < classes.length; ++i) {
            System.out.println(classes[i]);
        }
        return true;
    }
}

MyClass.java ：

/**
 * Documentation for my class
 */
public class MyClass {
    public static void main(String[] args) {
    }
    /**
     * Documentation for my static void method
     *
     * @param param This is the parameter it takes in
     */
    public static void myStaticVoidMethod(String param) {
    }
}

所以我要问的是为什么我会收到我上面发布的错误。如果有人能够提供更全面的指南来说明Doclet如何工作，那也很棒。

---

注意：我正在为我的项目使用 IntelliJ IDE。这是我的目录结构：

• 。想法
  • 。
• 外
  • 。
• 来源
  • 列表类.java
  • 我的班级.java
• JavadocGenerator.iml

Answer 1

你需要编译你的ListClass文件。像这样：

javac -d . ListClass.java -cp /path/to/tools.jar

Doclet 类是工具 jar 的一部分，因此您需要将其作为编译时依赖项包含在内。

然后你的命令

javadoc -doclet ListClass -docletpath .  MyClass.java

应该工作。

编辑

对于项目结构，如果从根目录编译，请确保通过其子目录引用文件，并确保任何绝对窗口路径都用双引号引起来：

javac -d . ./src/ListClass.java -cp "C:/Program Files/Java/jdk1.8.0_66/lib/tools.jar"

这将在项目的根目录下创建一个编译的ListClass文件，并从那里使用javadoc命令：

javadoc -doclet ListClass -docletpath .  ./src/MyClass.java

最好创建一个类目录来放置编译的类，而不是放在项目的根目录中，但我只是在使用您提供的结构。有关更多信息，请参阅 javac 和 javadoc 的文档。