生成自定义javadoc的麻烦; ＆＃39;找不到doclet＆＃39;

Question

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

我关注the official documentation并且最初在我的项目中包含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。这是我的目录结构：

• .idea
  • ...
• 出
  • ...
• SRC
  • ListClass.java
  • MyClass.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的文档。