Vì tôi sử dụng Maven, tôi đã có thể xây dựng và cài đặt trong các dự án kho lưu trữ cục bộ có các thẻ Javadoc chưa hoàn chỉnh (ví dụ: một tham số bị thiếu).

Tuy nhiên, vì tôi đã di chuyển sang Java 8 (1.8.0-ea-b90), Maven hoàn toàn nghiêm ngặt về việc thiếu các thẻ tài liệu và cho tôi thấy rất nhiều lỗi Javadoc liên quan đến các vấn đề Javadoc khi tôi cố gắng xây dựng hoặc cài đặt một dự án mà Javadoc không "hoàn hảo". Một số dự án tôi đang cố gắng biên dịch và cài đặt trong kho lưu trữ cục bộ của tôi là các dự án của bên thứ ba mà tôi không có quyền kiểm soát. Vì vậy, cách giải quyết của việc sửa tất cả các Javadocs trong tất cả các dự án này dường như không khả thi trong kịch bản của tôi.

Đây là một phần nhỏ của đầu ra mà tôi thấy khi tôi thực hiện mvn clean package installtrong dự án của mình:

[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 9.026s
[INFO] Finished at: Mon Apr 08 21:06:17 CEST 2013
[INFO] Final Memory: 27M/437M
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.9:jar (attach-javadocs) on project jpc: MavenReportException: Error while creating archive:
[ERROR] Exit code: 1 - /Users/sergioc/Documents/workspaces/heal/jpc/src/main/java/org/jpc/engine/prolog/PrologDatabase.java:10: error: @param name not found
[ERROR] * @param terms the terms to assert
[ERROR] ^
[ERROR] /Users/sergioc/Documents/workspaces/heal/jpc/src/main/java/org/jpc/engine/prolog/PrologDatabase.java:11: warning: no description for @return
[ERROR] * @return
[ERROR] ^

Plugin Javadoc Maven được cấu hình như thế này trong POM của tôi:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>2.9</version>
    <executions>
        <execution>
            <id>attach-javadocs</id>
            <goals>
                <goal>jar</goal>
            </goals>
        </execution>
    </executions>
</plugin>

Như tôi đã nói trước đây, mọi thứ đều hoạt động tốt nếu tôi quay lại Java 7. Có lẽ đây là một lỗi liên quan đến Maven đang chạy trong Java 8? Làm cách nào tôi có thể làm cho nó hoạt động (nghĩa là có thể xây dựng Javadoc của dự án và cài đặt mã của nó trong kho lưu trữ cục bộ của tôi) với Java 8? Tôi đã thử nghiệm với cả Maven 3.0.3 và 3.0.5 trong OSX.

CẬP NHẬT:

Nếu tôi thay đổi cấu hình plugin Javadoc bằng <failOnError>false</failOnError>(cảm ơn Martin):

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>2.9</version>
    <executions>
        <execution>
            <id>attach-javadocs</id>
            <goals>
                <goal>jar</goal>
            </goals>
        </execution>
    </executions>
</plugin>

Sau đó, dự án được cài đặt trong kho lưu trữ cục bộ của tôi. Tuy nhiên, JAR Javadoc vẫn chưa được tạo.

Một phần của đầu ra mà tôi thấy trong bảng điều khiển có cấu hình mới này là:

[ERROR] MavenReportException: Lỗi khi tạo tệp lưu trữ: Mã thoát: 1 - /Users/....java:18: cảnh báo: no @param ... Dòng lệnh là: / Library / Java / Home / bin / javadoc @options @ gói

Tham khảo các tệp Javadoc được tạo trong thư mục '/ Users / sergioc / Documents / workspaces / heal / minitoolbox / target / apidocs'.

tại org.apache.maven.plugin.javadoc.AbaugeJavadocMojo.executeJavadocCommandLine (Tóm tắtJavadocMojo.java:5043) tại org.apache.maven.plugin.javadoc. .javadoc.JavadocJar.execute (JavadocJar.java:181) tại org.apache.maven.plugin.DefaultBuildPluginManager.executeMojo (DefaultBuildPluginManager.java: 110. : 209) tại org.apache.maven.lifecycle.iternal.MojoExecutor.execute (MojoExecutor.java:153) tại org.apache.maven.lifecycle.i INTERNal.MojoExecutor.execute (MojoExecutor.java. maven.lifecycle.iternal.LifecyclModuleBuilder.buildProject (LifecyclModuleBuilder.java:84) tại org.apache.maven.lifecycle.i INTERNal.LifecyclModuleBuilder.buildProject (LifecyclModuleBuilder.java:59) tại org.apache.maven.lifecycl.i INTERNal.LifecyclStarter.singleThreadedBuild (LifecyclStarter.java:183) tại org.apache.maven.lifecycl.i INTERNal tại org.apache.maven.DefaultMaven.doExecute (DefaultMaven.java:320) tại org.apache.maven.DefaultMaven.execute (DefaultMaven.java:156) tại org.apache.maven.cli.MavenCli.execute (MavenCli.execute : 537) tại org.apache.maven.cli.MavenCli.doMain (MavenCli.java:196) tại org.apache.maven.cli.MavenCli.main (MavenCli.java:141) tại sun.reflect.NativeMethodAcoror Phương thức gốc) tại sun.reflect.NativeMethodAccessorImpl.invoke (NativeMethodAccessorImpl.java:57) tại sun.reflect.DelegatingMethodAccessorImpl.invoke (DelegatingMethodAccessorImpl.java:gọi (Phương thức.java: 491) tại org.codehaus.plexus. classworlds.launcher.Launcher.launchEnhified (Launcher.java:290) tại org.codehaus.plexus. classworlds.launcher.Launcher.launch (Launcher.java tại org.codehaus.plexus. classworlds.launcher.Launcher.mainWithExitCode (Launcher.java:409) tại org.codehaus.plexus. classworlds.launcher.Launcher.main (Launcher.java:352)

Bất kỳ cách giải quyết nào về cách xây dựng các nguồn, cài đặt dự án và tạo JAR Javadoc trong một bước khi nó hoạt động với Java 7?

Giải pháp tốt nhất sẽ là sửa các lỗi javadoc. Nếu vì một lý do nào đó không thể (ví dụ: mã nguồn được tạo tự động) thì bạn có thể vô hiệu hóa kiểm tra này.

DocLint là một tính năng mới trong Java 8 , được tóm tắt là:

Cung cấp một phương tiện để phát hiện lỗi trong các nhận xét Javadoc sớm trong chu kỳ phát triển và theo cách dễ dàng liên kết trở lại mã nguồn.

Điều này được bật theo mặc định và sẽ chạy rất nhiều kiểm tra trước khi tạo Javadocs. Bạn cần tắt cái này cho Java 8 như được chỉ định trong luồng này . Bạn sẽ phải thêm phần này vào cấu hình maven của bạn:

<profiles>
  <profile>
    <id>java8-doclint-disabled</id>
    <activation>
      <jdk>[1.8,)</jdk>
    </activation>
    <properties>
      <javadoc.opts>-Xdoclint:none</javadoc.opts>
    </properties>
  </profile>
</profiles>
<build>
  <plugins>
    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.9</version>
        <executions>
            <execution>
                <id>attach-javadocs</id>
                <goals>
                    <goal>jar</goal>
                </goals>
                <configuration>
                    <additionalparam>${javadoc.opts}</additionalparam>
                </configuration>
            </execution>
        </executions>
    </plugin>
    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-site-plugin</artifactId>
        <version>3.3</version>
        <configuration>
          <reportPlugins>
            <plugin>
              <groupId>org.apache.maven.plugins</groupId>
              <artifactId>maven-javadoc-plugin</artifactId>
              <configuration>
                <additionalparam>${javadoc.opts}</additionalparam>
              </configuration>
            </plugin>
          </reportPlugins>
        </configuration>
      </plugin>
   </plugins>
</build>

Đối với maven-javadoc-plugin 3.0.0+: Thay thế

<additionalparam>-Xdoclint:none</additionalparam>

với

<doclint>none</doclint>

Cách tiếp cận dễ nhất để mọi thứ hoạt động với cả java 8 và java 7 là sử dụng một hồ sơ trong bản dựng:

<profiles>
  <profile>
    <id>doclint-java8-disable</id>
    <activation>
      <jdk>[1.8,)</jdk>
    </activation>

    <build>
      <plugins>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-javadoc-plugin</artifactId>
          <configuration>
            <additionalparam>-Xdoclint:none</additionalparam>
          </configuration>
        </plugin>
      </plugins>
    </build>
  </profile>
</profiles>

Dưới đây là cách ngắn gọn nhất mà tôi biết để bỏ qua các cảnh báo doclint bất kể phiên bản java được sử dụng. Không cần phải sao chép cấu hình plugin trong nhiều cấu hình với sửa đổi nhỏ.

<profiles>
  <profile>
    <id>doclint-java8-disable</id>
    <activation>
      <jdk>[1.8,)</jdk>
    </activation>
    <properties>
      <javadoc.opts>-Xdoclint:none</javadoc.opts>
    </properties>
  </profile>
</profiles>

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-javadoc-plugin</artifactId>
      <version>2.9.1</version>
      <executions>
        <execution>
          <id>attach-javadocs</id> <!-- The actual id should be apparent from maven output -->
          <configuration>
            <additionalparam>${javadoc.opts}</additionalparam>
          </configuration>
        </execution>
      </executions>
    </plugin>
    ...
  </plugins>
</build>

Đã thử nghiệm trên oracle / open jdk 6, 7, 8 và 11.

Thêm vào phần thuộc tính toàn cầu trong tệp pom:

<project>
    ...
    <properties>
        <additionalparam>-Xdoclint:none</additionalparam>
    </properties>

Giải pháp chung được cung cấp ở đây trong các câu trả lời khác (thêm thuộc tính đó trong phần bổ trợ) không hoạt động vì một số lý do. Chỉ bằng cách đặt nó trên toàn cầu, tôi mới có thể xây dựng jar javadoc thành công.

Giải pháp ngắn nhất sẽ hoạt động với mọi phiên bản Java:

<profiles>
    <profile>
        <id>disable-java8-doclint</id>
        <activation>
            <jdk>[1.8,)</jdk>
        </activation>
        <properties>
            <additionalparam>-Xdoclint:none</additionalparam>
        </properties>
    </profile>
</profiles>

Chỉ cần thêm nó vào POM của bạn và bạn sẽ ổn.

Về cơ bản, đây là câu trả lời của @ ankon cộng với câu trả lời của @ zapp .

Đối với người dùng maven-javadoc-plugin 3.0.0:

Thay thế

<additionalparam>-Xdoclint:none</additionalparam>

bởi

<doclint>none</doclint>

Tôi không nghĩ chỉ cần tắt DocLint là một giải pháp tốt, ít nhất là không lâu dài. Thật tốt khi Javadoc đã trở nên nghiêm ngặt hơn một chút vì vậy cách đúng đắn để khắc phục vấn đề xây dựng là khắc phục vấn đề tiềm ẩn . Có, cuối cùng bạn sẽ cần sửa các tệp mã nguồn đó.

Dưới đây là những điều cần chú ý mà trước đây bạn có thể thoát khỏi:

• HTML không đúng định dạng (ví dụ: thẻ kết thúc bị thiếu, dấu ngoặc không thoát, v.v.)
• {@link }S không hợp lệ (tương tự với các thẻ tương tự như @see)
• Các @authorgiá trị không hợp lệ . Điều này đã từng được chấp nhận: @author John <john.doe@mine.com>nhưng không còn như vậy nữa vì các dấu ngoặc không thoát.
• Các bảng HTML trong Javadoc hiện yêu cầu tóm tắt hoặc chú thích. Xem câu hỏi này để giải thích.

Bạn chỉ cần sửa các tệp mã nguồn của mình và tiếp tục xây dựng Javadoc cho đến khi nó có thể xây dựng mà không gặp sự cố. Cồng kềnh có, nhưng cá nhân tôi thích khi tôi đã đưa các dự án của mình lên cấp độ DocLint bởi vì điều đó có nghĩa là tôi có thể tin tưởng hơn rằng Javadoc tôi sản xuất thực sự là những gì tôi dự định.

Tất nhiên có vấn đề nếu bạn đang tạo Javadoc trên một số mã nguồn mà bạn không tự sản xuất, ví dụ như vì nó đến từ một số trình tạo mã, ví dụ như wsimport . Điều kỳ lạ là Oracle đã không chuẩn bị các công cụ của riêng họ để tuân thủ JDK8 trước khi thực sự phát hành JDK8. Có vẻ như nó sẽ không được sửa cho đến Java 9 . Chỉ trong trường hợp cụ thể này, tôi đề nghị tắt DocLint như tài liệu ở nơi khác trên trang này.

Chỉ ghi đè maven-javadoc-plugincấu hình, không khắc phục sự cố với mvn site(được sử dụng, ví dụ trong giai đoạn phát hành). Đây là những gì tôi phải làm:

<profile>
  <id>doclint-java8-disable</id>
  <activation>
    <jdk>[1.8,)</jdk>
  </activation>
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <configuration>
          <additionalparam>-Xdoclint:none</additionalparam>
        </configuration>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-site-plugin</artifactId>
        <version>3.3</version>
        <configuration>
          <reportPlugins>
            <plugin>
              <groupId>org.apache.maven.plugins</groupId>
              <artifactId>maven-javadoc-plugin</artifactId>
              <configuration>
                <additionalparam>-Xdoclint:none</additionalparam>
              </configuration>
            </plugin>
          </reportPlugins>
        </configuration>
      </plugin>
    </plugins>
  </build>
</profile>

Bạn có thể thử đặt thuộc failOnErrortính (xem tài liệu plugin ) thành false:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>2.9</version>
    <executions>
        <execution>
            <id>attach-javadocs</id>
            <goals>
                <goal>jar</goal>
            </goals>
            <configuration>
              <failOnError>false</failOnError>
            </configuration>
        </execution>
    </executions>
</plugin>

Như bạn có thể thấy từ các tài liệu, giá trị mặc định là true.

Vì nó phụ thuộc vào phiên bản JRE của bạn, được sử dụng để chạy lệnh maven mà bạn có thể không muốn tắt DocLinttheo mặc định trong pom.xml của mình

Do đó, từ dòng lệnh bạn có thể sử dụng chuyển đổi -Dadditionalparam=-Xdoclint:none.

Thí dụ: mvn clean install -Dadditionalparam=-Xdoclint:none

Tên thuộc tính cấu hình đã được thay đổi trong phiên bản mới nhất của maven-javadoc-plugin là 3.0.0.

Do đó <Extraparam> sẽ không hoạt động. Vì vậy, chúng tôi phải sửa đổi nó như dưới đây.

   <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-javadoc-plugin</artifactId>
      <version>3.0.0</version>
      <configuration>
         <doclint>none</doclint>
      </configuration>
  </plugin>

Tôi muốn thêm một số cái nhìn sâu sắc vào câu trả lời khác

Trong trường hợp của tôi

-Xdoclint: không có

Không hoạt động.

Hãy bắt đầu với điều đó, trong dự án của tôi, tôi thực sự không cần javadoc. Chỉ một số plugin cần thiết có thời gian xây dựng phụ thuộc vào nó.

Vì vậy, cách đơn giản nhất để giải quyết vấn đề của tôi là:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <configuration>
        <skip>true</skip>
    </configuration>
</plugin>

Tính đến maven-javadoc-Plugin 3.0.0 bạn nên đã được sử dụng additionalJOption để thiết lập một tùy chọn Javadoc bổ sung, vì vậy nếu bạn muốn Javadoc để vô hiệu hóa doclint, bạn nên thêm các tài sản sau đây.

<properties>
    ...
    <additionalJOption>-Xdoclint:none</additionalJOption>
    ...
<properties>

Bạn cũng nên đề cập đến phiên bản của maven-javadoc-plugin là 3.0.0 trở lên.

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>3.0.0</version>    
</plugin>

Vì vậy, hãy tiết kiệm cho mình một vài giờ mà tôi đã không làm và thử điều này nếu nó dường như không hoạt động:

 <additionalJOption>-Xdoclint:none</additionalJOption>

Thẻ được thay đổi cho các phiên bản mới hơn.

Đã thêm bên dưới

JAVA_TOOL_OPTIONS=-DadditionalJOption=-Xdoclint:none

Vào công việc của Jenkins:

Cấu hình> Môi trường xây dựng> Tiêm các biến môi trường vào quá trình xây dựng> Thuộc tính Nội dung

Đã giải quyết vấn đề xây dựng mã của tôi thông qua Jenkins Maven :-)

Tôi không chắc điều này có giúp ích gì không, nhưng ngay cả tôi cũng gặp phải vấn đề tương tự chính xác gần đây với phiên bản oozie-4.2.0 . Sau khi đọc qua các câu trả lời ở trên, tôi vừa thêm tùy chọn maven thông qua dòng lệnh và nó hoạt động với tôi. Vì vậy, chỉ cần chia sẻ ở đây.

Tôi đang sử dụng java 1.8.0_77 , chưa thử với java 1.7

bin / mkdistro.sh -DskipTests -Dmaven.javadoc.opts = '- Xdoclint: -html'

Để bỏ qua thiếu @paramvà @returnthẻ, nó đủ để vô hiệu hóa missing nhóm doclint . Theo cách này, javadoc vẫn sẽ được kiểm tra các vấn đề cú pháp và cấp độ cao hơn:

    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>3.0.0</version>
        <configuration>
            <doclint>all,-missing</doclint>
        </configuration>
    </plugin>

Lưu ý rằng đây là phiên bản plugin 3.0 hoặc mới hơn.

Tôi đến bữa tiệc hơi muộn, nhưng tôi cũng bị buộc phải tìm kiếm cách giải quyết, kết thúc ở đây, và sau đó tìm thấy nó.

Đây là những gì làm việc cho tôi: -

export JAVA_TOOL_OPTIONS=-DadditionalJOption=-Xdoclint:none

Và sau đó bắt đầu xây dựng Maven của bạn, bất kỳ bản phân phối Linux xây dựng, vv Đẹp điều về nó mà nó không đòi hỏi Maven cấu hình files sẽ chỉnh sửa - Tôi không thể làm điều đó như mục tiêu của tôi là để xây dựng lại một loạt các Centos gói rpm, vì vậy phải đi thật sâu