Maven - Documenti di progetto

Questo tutorial ti insegnerà come creare la documentazione dell'applicazione in una volta sola. Quindi iniziamo, vai alla directory C: / MVN in cui hai creato il tuo javaconsumerBankingapplicazione utilizzando gli esempi forniti nei capitoli precedenti. ApertoconsumerBanking cartella ed eseguire quanto segue mvn comando.

C:\MVN>mvn site

Maven inizierà a costruire il progetto.

[INFO] Scanning for projects...
[INFO]-----------------------------------------------
[INFO] Building consumerBanking
[INFO] task-segment: [site]
[INFO]-----------------------------------------------
[INFO] [site:site {execution: default-site}]
[INFO] artifact org.apache.maven.skins:maven-default-skin:
checking for updates from central

[INFO] Generating "About" report.
[INFO] Generating "Issue Tracking" report.
[INFO] Generating "Project Team" report.
[INFO] Generating "Dependencies" report.
[INFO] Generating "Continuous Integration" report.
[INFO] Generating "Source Repository" report.
[INFO] Generating "Project License" report.
[INFO] Generating "Mailing Lists" report.
[INFO] Generating "Plugin Management" report.
[INFO] Generating "Project Summary" report.

[INFO]-----------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO]-----------------------------------------------

[INFO] Total time: 16 seconds
[INFO] Finished at: Wed Jul 11 18:11:18 IST 2012
[INFO] Final Memory: 23M/148M
[INFO]-----------------------------------------------

La documentazione del tuo progetto è ora pronta. Maven ha creato un sito all'interno della directory di destinazione.

Apri la cartella C: \ MVN \ consumerBanking \ target \ site. Fare clic su index.html per visualizzare la documentazione.

Maven crea la documentazione utilizzando un motore di elaborazione della documentazione chiamato Doxia che legge più formati sorgente in un modello di documento comune. Per scrivere la documentazione per il tuo progetto, puoi scrivere il tuo contenuto in alcuni dei seguenti formati comunemente usati che vengono analizzati da Doxia.

Nome formato	Descrizione	Riferimento
XDoc	Un formato di documentazione Maven 1.x.	https://jakarta.apache.org/site
FML	Utilizzato per i documenti delle FAQ	https://maven.apache.org