Maven 프로젝트 문서

이 장에서는 Maven 프로젝트 문서를 생성하는 방법을 주로 배웁니다.

예를 들어 우리는 C:를 사용합니다./MVN 디렉토리에서 consumerBanking 프로젝트가 생성되었습니다. Maven은 다음 명령어를 사용하여 빠르게 Java 프로젝트를 생성합니다：

mvn archetype:generate　-DgroupId=com.companyname.bank　-DartifactId=consumerBanking　-DarchetypeArtifactId=maven-archetype-quickstart　-DinteractiveMode=false

pom.xml을 수정하여 다음 설정을 추가하세요（만약 추가되지 않았다면）：

<project>
　　...
<build>
<pluginManagement>
　　　　<plugins>
　　　　　　　　<plugin>
　　　　　　　　　　<groupId>org.apache.maven.plugins</<groupId>
　　　　　　　　　　<artifactId>maven-site-plugin</<artifactId>
　　　　　　　　　　<version>3.3</version>
　　　　　　　　</plugin>
　　　　　　　　<plugin>
　　　　　　　　　　<groupId>org.apache.maven.plugins</<groupId>
　　　　　　　　　　<artifactId>maven-project-info-reports-plugin</<artifactId>
　　　　　　　　　　<version>2.7</version>
　　　　　　　　</plugin>
　　　　</plugins>
　　　　</pluginManagement>
</build>
　...
</project>

그렇지 않으면 mvn site 명령어를 실행할 때 java.lang.NoClassDefFoundError: org/apache/maven/doxia/siterenderer/DocumentContent 문제로 인해 발생합니다. 이는 maven-site-플러그인 버전이 너무 낮습니다. 버전을 업그레이드하세요 3.3+ 그렇게만 됩니다.

consumerBanking 폴더를 열고 다음 mvn 명령어를 실행하세요.

C:\MVN\consumerBanking> mvn site

Maven가 문서 생성 시작:

[INFO] 프로젝트 검색 중...
[INFO]　-------------------------------------------------------------------
[INFO] consumerBanking 빌드 중
[INFO] 작업-segment: [site]
[INFO]　-------------------------------------------------------------------
[INFO] [site:site {execution: default-site}]
[INFO] 아티펙트 org.apache.maven.skins:maven-기본-스킨:　
센트럴에서 업데이트 확인 중
[INFO] 약관 보고서 생성 중.
[INFO] 이슈 추적 보고서 생성 중.
[INFO] 프로젝트 팀 보고서 생성 중.
[INFO] 의존성 보고서 생성 중.
[INFO] 지속적 통합 보고서 생성 중.
[INFO] 소스 리포지토리 보고서 생성 중.
[INFO] 프로젝트 라이선스 보고서 생성 중.
[INFO] "메일링 목록" 보고서 생성.
[INFO] "플러그인 관리" 보고서 생성.
[INFO] "프로젝트 요약" 보고서 생성.
[INFO]　-------------------------------------------------------------------
[INFO] 빌드 성공
[INFO]　-------------------------------------------------------------------
[INFO] 총 시간:　16　초
[INFO] 완료 시간: 월요일 jul　11　18:11:18　IST　2012
[INFO] 최종 메모리:　23M/148M
[INFO]　-------------------------------------------------------------------

를 C:\MVN\consumerBanking\target\site 폴더. index.html 되면 문서를 볼 수 있습니다.

Maven은 이름이 Doxia의 문서 처리 엔진을 사용하여 문서를 생성하면, 그것은 여러 가지 형식의 소스 코드를 일반 문서 모델로 변환할 수 있습니다. 프로젝트에 문서를 작성하려면, Doxia가 변환할 수 있는 다음과 같은 일반적인 형식 중 하나로 내용을 작성할 수 있습니다.