maven javadoc非法包名错误

Question

我在运行mvn javadoc时遇到以下错误：javadoc

[错误]退出代码：1-javadoc：错误-非法包名称："edu.princeton.cs.1-Fundamentals.1-1-BasicProgModel"

原因我很清楚，但我不知道如何解决它。

这是我在文件夹src/main/java/edu/princeton/cs/中的src文件结构。

├── 1-Fundamentals
│   ├── 1-1-BasicProgModel
│   ├── 1-2-DataAbstraction
│   ├── 1-3-BagsQueuesStacks
│   ├── 1-4-AnalysisOfAlgorithms
│   └── 1-5-UnionFind
├── 2-Sorting
│   ├── 2-1-ElementarySorts
│   ├── 2-2-Mergesort

在每个目录中，java代码都包含包edu。普林斯顿大学反恐精英。algs4；

这意味着文件夹名不是包名。然而，javadoc错误地认为文件夹名是包名。

我怎么能让maven知道没有像edu.princeton.cs.1-Fundamentals.1-1-BasicProgModel这样的包




Answer 1

你的路径是否包含空格。如果任何目录名包含空格，那么javadoc插件似乎失败了。

例子：

糟糕的路线：我的项目/java项目/我的新游戏

好路线：MyProject/Project java/My new game

Answer 2

您试图违背Maven的惯例使用它。默认情况下，除非明确说明，否则项目的源代码根位于src/main/java下。这意味着下面的任何目录都将被视为包名称的一部分，因此必须与. java源文件中声明的包名称相匹配。

现在，您可以重写约定，并告诉Maven考虑另一个目录源根，以便JavaC或JavaDoc工作如预期：

::pom.xml:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>example</groupId>
    <artifactId>example</artifactId>
    <version>1.0-SNAPSHOT</version>
    <build>
        <!--Overrides the default:-->
        <!--<sourceDirectory>src/main/java</sourceDirectory>-->
        <sourceDirectory>./path/relative/to/pom.xml/</sourceDirectory>
    </build>
</project>

由于在这个项目中有多个来源，您可以考虑添加单独的POM。xml，或者更改布局并添加其他源目录，以及pom中的附加插件。xml:

项目结构：

    Project Directory
    ├── 1-Fundamentals
    │   ├── 1-1-BasicProgModel
    │   │   ├──src
    │   │   │  └──edu/princeton/cs/algs4 (only classes and directories matching packages)
    │   │   │     ├── JavaClass1.java
    │   │   │     └── JavaClass2.java
    │   │   └── other non source content
    │   ├── 1-2-DataAbstraction
    │   │   ├──src
    │   │   │  └──edu/princeton/cs/algs4
    │   │   │     ├── JavaClass3.java
    │   │   │     └── JavaClass4.java
    │   │   └── other non source content
    │   └── 1-3-BagsQueuesStacks
    │       ├──src
    │       │  └──edu/princeton/cs/algs4
    │       │     ├── JavaClass5.java
    │       │     └── JavaClass6.java
    │       └── other non source content
    └── pom.xml

告诉maven源根在哪里：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>example</groupId>
    <artifactId>example</artifactId>
    <version>1.0-SNAPSHOT</version>

    <build>
        <plugins>
            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>build-helper-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <phase>generate-sources</phase>
                        <goals><goal>add-source</goal></goals>
                        <configuration>
                            <sources>
                                <source>1-Fundamentals/1-1-BasicProgModel/src</source>
                                <source>1-Fundamentals/1-2-DataAbstraction/src</source>
                                <source>1-Fundamentals/1-3-BagsQueuesStacks/src</source>
                            </sources>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>