在典型的Maven项目中,项目文档(需求等)应存储在哪里?标准目录布局介绍页面列出的目录都不是显而易见的选择。
很遗憾,没有一种公约。如果你想让文档成为生成网站的一部分,那么 /src/site
显然是个不错的地方。也许你甚至可以用APT格式写文档?
但更有可能的是,你有一组文档、pdf和xls文件、图形、电子邮件等。你可以将它们放在 /src/site
下,并在网站中放置超链接,或者......定义自己的公约,可惜了。通常我看到过 /src/main/doc(s)
,/src/doc(s)
,甚至是 /doc(s)
。
你不想将文档放在 /src/main/resources
或者 src/main/webapp
,因为这些文件将成为构建产物(JAR/WAR)的一部分,这是很少需要的。
http://www.sonatype.com/books/mvnref-book/reference/site-generation-sect-dir-struct.html 推荐以下结构:
sample-project
+- src/
[..]
+- resources/
| +- images/
| | +- banner-left.png
| | +- banner-right.png
| |
| +- architecture.html
| +- jira-roadmap-export-2007-03-26.html
[..]
可以使用
<javadocDirectory/>
参数在生成的 javadoc 中包含其他资源,如 HTML 或图像。然后您可以在 javadoc 注释中链接到这些资源。默认情况下,所有 javadoc 资源都在${basedir}/src/main/javadoc
目录中。请注意,您需要设置docfilessubdirs
参数以复制这些文件。