我知道我可以在javadoc中使用IMG
標記。但是在哪裏放置圖像文件?如果我將它們與java文件一起放入,它們將在編譯期間轉到JAR
文件或class
文件夾,這不是必需的。何處爲Javadoc放置圖像文件?
如何讓圖像文件僅與javadoc相關,而不與代碼資源相關?
我知道我可以在javadoc中使用IMG
標記。但是在哪裏放置圖像文件?如果我將它們與java文件一起放入,它們將在編譯期間轉到JAR
文件或class
文件夾,這不是必需的。何處爲Javadoc放置圖像文件?
如何讓圖像文件僅與javadoc相關,而不與代碼資源相關?
如Javadoc tool documentation規定,「雜項未處理的文件」一節中:
要包括未加工的文件,把它們放在一個目錄名爲doc-文件 它可以是任何包目錄的子目錄包含 源文件。每個包可以有一個這樣的子目錄。您可能包含圖像,示例代碼,源文件,.class文件, 小程序和HTML文件。例如,如果要在java.awt.Button類文檔中包含button button.gif的圖像 ,則您將 放入/ home/user/src/java/awt/doc-files /目錄中。 注意doc-files目錄不應位於 /home/user/src/java/doc-files,因爲java不是一個包 - 是,它不直接包含任何源文件。
這意味着圖像文件必須作爲源目錄結構的一部分提供。這意味着您的構建過程應該設計爲避免將這些文件複製到類目錄結構中。原始javac
工具不會執行該副本,並且您必須配置IDE或構建腳本(maven,ant,gradle等)以在編譯或jar步驟中排除這些文件。
從來沒有使用它,但我想使用[docfilessubdirs選項](http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#docfilessubdirs)並指定一個額外的[包含docfiles目錄的父目錄的源路徑(http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#sourcepath)可以正常工作。 – 2014-09-28 12:32:00