プロジェクトドキュメントは、典型的なMavenプロジェクトに格納する必要があります

プロジェクトのドキュメント（要件など）は、典型的なMavenプロジェクトに格納する必要があります。プロジェクトドキュメントは、典型的なMavenプロジェクトに格納する必要があります

Introduction to the Standard Directory Layoutに記載されているディレクトリはありません。

2012-02-03 Anonymous

私は '/ docs'に投票します。 '/ src'の下にあるものは全てmavenの世界です。私はまた、プロジェクトそのものがドキュメンテーションの保存には役に立たないとも思っています。 wikiのインストールを検討してください。 –

mavenではすべてのソースファイルが/ srcにあります。あなたが編集する文書はソースファイルです。/ srcの下のどこかに置かなければなりません。新しくトップレベルのディレクトリを追加し始めたら、あなたのプロジェクトはMavenの規約に従わず、他の人が理解するのが難しくなります。 –

残念ながら、条約はありません。ドキュメントを生成されたサイトの一部にしたい場合は、明らかに/src/siteが良い場所です。たぶん、APT形式の文書を書くこともできますか？

しかし、より多くの可能性が高いあなたはどちらかだけでなく/src/site下に置くと、サイト内のハイパーリンクを入れたり...独自の規則を定義することができdoc、pdfとxlsファイル、グラフィックス、電子メールなどのセットを持っています、悲しいことに。典型的には、私は/src/main/doc(s),/src/doc(s)またはさらに/doc(s)を見た。

ドキュメントは/src/main/resourcesまたはsrc/main/webappに配置したくない場合があります。その場合、ファイルはほとんど望みがないビルドアーティファクト（JAR/WAR）の一部になります。

出典

2012-02-03 21:13:45

ソースではなくsrcですか？ – Line

http://www.sonatype.com/books/mvnref-book/reference/site-generation-sect-dir-struct.html はmaven-javadoc-pluginによれば、以下の構造

sample-project 
+- src/ 
[..] 
+- resources/ 
| +- images/ 
| | +- banner-left.png 
| | +- banner-right.png 
| | 
| +- architecture.html 
| +- jira-roadmap-export-2007-03-26.html 
[..]

出典

2013-02-14 02:26:51 RobE

私はJoaoが別の提案を投稿するのではなく、この投稿を編集した理由を知りません。彼は確かに有効なオプションであるサイトフォルダの下にresourcesフォルダを置きます。投稿/引用された提案は、トップレベルのsrcフォルダとサイトフォルダの隣にresourcesフォルダを使用します（記事のリンクを参照）。必ずしもすべての文書をサイトに含める必要はありません。 – RobE

申し訳ありません@ローブ、私の間違い。 –

をお勧めします：

<javadocDirectory/>パラメータが生成されたJavadocに、HTMLまたは画像のような追加のリソースを含むように使用することができます。 javadocのコメントでこれらのリソースにリンクすることができます。デフォルトでは、すべてのjavadocリソースは${basedir}/src/main/javadocディレクトリにあります。これらをコピーするには、docfilessubdirsパラメータを設定する必要があることに注意してください。

出典

2015-06-18 23:51:13 Alun

一般的なドキュメントとJavaDocの違いは分かりますか？ :) – Line

多少。 JavaDocをフォーマット/ドキュメントジェネレータとして見ると、問題は決してAPIだけを文書化するのではなく、その使い方を説明するドキュメントを書くことです。 JavaDocs/Codeを*持ってAPIにリンクすることは、常に良いアイデアのようです。 * API以外のものを文書化している場合は、他のものを使用できると思われます（例：マークダウン）。 – Alun

プロジェクトドキュメントは、典型的なMavenプロジェクトに格納する必要があります

答えて

関連する問題