项目文档应该存储在典型的maven项目中

Question

项目文档（要求等）应该存储在典型的maven项目中。

Introduction to the Standard Directory Layout页面中列出的所有目录都不是明显的候选人。

Answer 1

不幸的是没有惯例。如果您希望文档成为生成的网站的一部分，显然/src/site是一个好地方。也许你甚至可以用APT格式编写文档？

但您更有可能拥有一组doc，pdf和xls个文件，图片，电子邮件等。您可以将它们放在/src/site下好吧，并把超链接放在网站或...定义你自己的约定，遗憾的是。通常我看过/src/main/doc(s)，/src/doc(s)甚至/doc(s)。

您不希望将文档放在/src/main/resources或src/main/webapp中，因为这些文件将成为很少需要的构建工件（JAR / WAR）的一部分。

Answer 2

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
[..]

Answer 3

根据maven-javadoc-plugin：

  

<javadocDirectory/>参数可用于在生成的javadoc中包含其他资源，如HTML或图像。然后，您可以在javadoc注释中链接到这些资源。默认情况下，所有javadoc资源都位于${basedir}/src/main/javadoc目录中。请注意，您需要设置docfilessubdirs参数来复制这些参数。