在哪里放置Javadoc的图像文件?

时间:2014-09-28 12:17:24

标签: java image javadoc

我知道我可以在javadoc中使用IMG标记。但是在哪里放图像文件?如果我将它们与java文件一起放在一起,它们将在编译期间转到JAR文件或class文件夹,这不是必需的。

如何使用仅与javadoc相关的图像文件,而不是代码资源?

1 个答案:

答案 0 :(得分:2)

Javadoc tool documentation中所述,在“其他未处理的文件”部分中:

  

要包含未处理的文件,请将它们放在名为doc-files的目录中   它可以是包含的任何包目录的子目录   源文件。每个包都可以有一个这样的子目录。您   可能包括图像,示例代码,源文件,.class文件,   小程序和HTML文件。例如,如果要包含图像   您可以在java.awt.Button类文档中找到button.gif按钮   将该文件放在/ home / user / src / java / awt / doc-files /目录中。   请注意,doc-files目录不应位于   / home / user / src / java / doc-files因为java不是包 - 那   是,它不直接包含任何源文件。

这意味着必须将图像文件作为源目录结构的一部分提供。这意味着您的构建过程应该设计为避免将这些文件复制到classes目录结构中。原始javac工具不执行复制,您必须配置IDE或构建脚本(maven,ant,gradle等)以在编译或jar步骤中排除这些文件。