반응형
Maven - Project Documents
(원문 위치 : http://www.tutorialspoint.com/maven/maven_project_documents.htm )
이 강좌는 한번에 프로그램 문서를 생성하는 방법에 대한 것이다. concumerBanking 프로그램을 생성한 C:\MVN로 가서 consumerBanking폴더를 열고 아래 mvn명령을 실행한다.
C:\MVN>mvn site
Maven은 프로젝트 build를 시작할 것이다.
[INFO] Scanning for projects... [INFO] [INFO] ------------------------------------------------------------------------ [INFO] Building consumerBanking 1.0-SNAPSHOT [INFO] ------------------------------------------------------------------------ [INFO] [INFO] --- maven-site-plugin:3.3:site (default-site) @ consumerBanking --- [WARNING] Report plugin org.apache.maven.plugins:maven-project-info-reports-plugin has an empty version. [WARNING] [WARNING] It is highly recommended to fix these problems because they threaten the stability of your build. [WARNING] [WARNING] For this reason, future Maven versions might no longer support building such malformed projects. [INFO] configuring report plugin org.apache.maven.plugins:maven-project-info-reports-plugin:2.8.1 [INFO] Relativizing decoration links with respect to project URL: http://maven.apache.org [INFO] Rendering site with org.apache.maven.skins:maven-default-skin:jar:1.0 skin. [INFO] Generating "Dependencies" report --- maven-project-info-reports-plugin:2.8.1 [INFO] Generating "Dependency Convergence" report --- maven-project-info-reports-plugin:2.8.1 [INFO] Generating "Dependency Information" report --- maven-project-info-reports-plugin:2.8.1 [INFO] Generating "About" report --- maven-project-info-reports-plugin:2.8.1 [INFO] Generating "Plugin Management" report --- maven-project-info-reports-plugin:2.8.1 [INFO] Generating "Project Plugins" report --- maven-project-info-reports-plugin:2.8.1 [INFO] Generating "Project Summary" report --- maven-project-info-reports-plugin:2.8.1 [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------ [INFO] Total time: 37.828 s [INFO] Finished at: 2015-09-27T12:11:27+05:30 [INFO] Final Memory: 23M/247M [INFO] ------------------------------------------------------------------------
그거다! 프로젝트 문서가 준비되었다. Maven은 target 디렉토리에 site를 생성했다.
C:\MVN\consumerBanking\target\site 폴더를 열고 index.html을 문서를 보기위해 선택하자.
Maven은 Doxia라 불리우는 documentation-processing engine을 사용하여 문서를 만든다. (http://maven.apache.org/doxia/index.html 참고) 이것은 다수의 소스를 읽어 공통 문서 모델로 형식화한다. 프로젝트에서 문서를 쓰기위해 Doxia가 parsing하는 아래와 같은 몇가지 공통적인 포멧을 따사 컨텐츠를 작성할 수 있다.
| Format Name | Description | Reference |
|---|---|---|
| APT | A Plain Text document format (순수문자 문서 포멧) | |
| XDoc | A Maven 1.x documentation format (Maven 1.x 문서 포멧) | |
| FML | Used for FAQ documents (FAQ 문서를 위해 사용됨) | |
| XHTML | Extensible HTML (확장 HTML) |
반응형