Maven2 Report使用maven-javadoc-plugin
簡介一下Maven2中maven-javadoc-plugin進行Report的使用。
更詳細的用法請參考：http://maven.apache.org/plugins/maven-javadoc-plugin/
簡易使用法：
基本上只要在reporting標籤中使用進行plugin的設定即可。之後在執行maven site時就會產生javadoc的文件資料。
| <reporting> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> </plugin> </plugins> </reporting> |
較複雜的使用法：
一般而言使用簡易的方式即可，但總有某些時候會出問題。
l 狀況一：
系統是使用MS950編碼的系統，但java程式卻是用UTF-8
解法：使用encoding標籤，指定*.java檔是使用何種編碼。
l 狀況二：
產生的javadoc api文件，但開啟後卻是亂碼(必須在瀏覽器中指定編碼後才正常)
解法：使用charset標籤，指定在網頁上是使用何種編碼。
l 狀況三：
某些*.java檔javadoclet撰寫有問題，導致無法順利產生JavaDoc API文件。
或者某些*.java文件並不想產生相關的java api文件時。
解法：使用excludePackageNames標籤，排除不希望產生api的package。
l 狀況四：
除了javadoclet預設的@parameter外，希望自行定義的@parameter資訊也能顯示於Java Doc API中。
解法：使用tags標籤，在其中指定tag的name、placement、head屬性即可。
| <reporting> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <encoding>UTF-8</encoding> <charset> UTF-8</charset> <excludePackageNames>org.*:arch.common.*</excludePackageNames> <tags> <tag> <name>hibernate.id</name> <placement>a</placement> <head>To do something:</head> </tag> </tags> </configuration> </plugin> </plugins> </reporting> |
標籤：
開發：Maven2
沒有留言:
張貼留言