Maven을 사용한 JavaDoc의 자동 확인

리팩토링하는 동안 JavaDoc이 오래되어서 자주 발생합니다. 여기에는 더 이상 존재하지 않는 메소드 인수 또는 실종 된 메소드 인수가 설명되어 있습니다.Maven을 사용한 JavaDoc의 자동 확인

"JavaDoc- 위반"이 있으면 기존 JavaDoc을 자동으로 검사하고 빌드를 중지하는 Maven 플러그인이 있으면 문제가되지 않습니다. Maven-JavaDoc-Plugin과 maven-doccheck를 보았지만 두 가지 모두 오류나 경고를 내기보다는 위반시 자동으로 기존 JavaDoc을 수정할 수 있습니다.

이 같은 몇 가지 메이븐 플러그인이 있다면 어떻게 알 수 있습니까? 이것을 보관하는 방법은 무엇입니까?

출처

2013-08-09 MrD

필자가 알고있는 한, 현재로서는 maven-javadoc-plugin을 사용할 수 없습니다. JavaDoc 플러그인에는 javadoc:fix mojo가 있지만 문제가 자동으로 해결됩니다.

최근에이 문제에 대한 JIRA 항목을 만들었습니다 : ~~MJAVADOC-374~~ (이것은 MJAVADOC-314의 중복입니다).

업데이트 : 당신은 Checkstyle 사용할 수있는 올바른의 JavaDoc을 확인합니다. 구성 옵션은 described here입니다. maven-checkstyle-plugin과 check-Mojo을 사용하여 이것을 당신의 메이븐 빌드에 통합하십시오.

예를 받는다는 설정은 다음과 같이 수 :

<project> 
    ... 
    <build> 
    <plugins> 
     <plugin> 
     <groupId>org.apache.maven.plugins</groupId> 
     <artifactId>maven-checkstyle-plugin</artifactId> 
     <version>2.15</version> 
     <configuration> 
      <logViolationsToConsole>true</logViolationsToConsole> 
      <checkstyleRules> 
      <module name="JavadocMethod"> 
       <property name="scope" value="public"/> 
       <property name="allowUndeclaredRTE" value="true"/> 
       <property name="allowMissingParamTags" value="false"/> 
      </module> 
      </checkstyleRules> 
     </configuration> 
     </plugin> 
    </plugins> 
    </build> 
    ... 
</project>

출처

2013-08-09 09:49:32

Maven을 사용한 JavaDoc의 자동 확인

답변

관련 문제