Maven - dokumenty projektowe

Ten samouczek nauczy Cię, jak za jednym zamachem stworzyć dokumentację aplikacji. Więc zacznijmy, przejdź do katalogu C: / MVN, w którym utworzyłeś swoją javaconsumerBankingzastosowanie na przykładach podanych w poprzednich rozdziałach. otwartyconsumerBanking folder i wykonaj następujące czynności mvn Komenda.

C:\MVN>mvn site

Maven rozpocznie budowę projektu.

[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]-----------------------------------------------

Twoja dokumentacja projektowa jest już gotowa. Maven utworzył witrynę w katalogu docelowym.

Otwórz folder C: \ MVN \ consumerBanking \ target \ site. Kliknij index.html, aby zobaczyć dokumentację.

Maven tworzy dokumentację za pomocą silnika przetwarzania dokumentacji o nazwie Doxia, który wczytuje wiele formatów źródłowych do wspólnego modelu dokumentu. Aby napisać dokumentację dla swojego projektu, możesz napisać treść w kilku następujących powszechnie używanych formatach, które są analizowane przez Doxia.

Nazwa formatu	Opis	Odniesienie
XDoc	Format dokumentacji Maven 1.x.	https://jakarta.apache.org/site
FML	Używany do dokumentów FAQ	https://maven.apache.org