项目文档应该存储在典型的Maven项目中
项目文档(需求等)应该存储在典型的Maven项目中。
“标准目录布局”简介中列出的目录都不是一个明显的候选项。
不幸的是没有约定。 如果你想要文档是生成的网站的一部分,显然/src/site
是一个好地方。 也许你甚至可以用APT格式写文档?
但更有可能你有一套doc
, pdf
和xls
文件,graphics,电子邮件等等。你可以把它们放在/src/site
,把超链接放在网站上或者…定义你自己的约定,可悲的。 通常我已经看到/src/main/doc(s)
, /src/doc(s)
甚至/doc(s)
。
您不希望将您的文档放置在/src/main/resources
或src/main/webapp
,因为这些文件将成为很less需要的构build工件(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 [..]
根据maven-javadoc-plugin :
可以使用
<javadocDirectory/>
参数在生成的javadoc中包含其他资源,如HTML或图像。 然后您可以链接到您的javadoc评论中的这些资源。 默认情况下,所有javadoc资源都位于${basedir}/src/main/javadoc
目录中。 请注意,您需要设置docfilessubdirs
参数来复制这些参数。