某些API文檔在包級別包含信息。例如java.io
包含這裏http://docs.oracle.com/javase/7/docs/api/java/io/package-summary.html從哪裏可以找到javadoc使用的java包級別的信息?
3包級部分中的部分是:「包java.io說明」,「包規範」和「相關文檔」。
我應該在哪裏將這些部分的內容放在我自己的項目中,以便javadoc以相同的方式處理它?
某些API文檔在包級別包含信息。例如java.io
包含這裏http://docs.oracle.com/javase/7/docs/api/java/io/package-summary.html從哪裏可以找到javadoc使用的java包級別的信息?
3包級部分中的部分是:「包java.io說明」,「包規範」和「相關文檔」。
我應該在哪裏將這些部分的內容放在我自己的項目中,以便javadoc以相同的方式處理它?
在每個包
內做創建一個名爲package-info.java
文件中的以下
/**
* Javadoc
*/
package my.cool.package123;
你必須把一個名爲package-info.java
文件到包含您的軟件包的文件夾。
你把一個package comment file(重點煤礦)的評論:
每個包都可以有自己的文檔註釋,包含在其自己的「源」文件,該Javadoc工具將合併到包的摘要它生成的頁面。您通常在此評論中包含適用於整個軟件包的任何文檔。
要創建一個包註釋文件,你有一個選擇的兩個文件,將您的意見:
package-info.java
- 可以包含一個包聲明,註解包,包註釋和Javadoc標記。 此文件通常優於package.html。package.html
- 只能包含包註釋和Javadoc標籤,沒有包註釋。