में संग्रहीत किया जाना चाहिए जहां प्रोजेक्ट प्रलेखन (आवश्यकताएं, आदि) को सामान्य मैवेन प्रोजेक्ट में संग्रहीत किया जाना चाहिए।प्रोजेक्ट प्रलेखन को ठेठ मैवेन प्रोजेक्ट
Introduction to the Standard Directory Layout पृष्ठ में सूचीबद्ध निर्देशिका में से कोई भी एक स्पष्ट उम्मीदवार है।
दुर्भाग्य से कोई सम्मेलन नहीं है। यदि आप दस्तावेज उत्पन्न साइट का हिस्सा बनना चाहते हैं, तो स्पष्ट रूप से /src/site एक अच्छी जगह है। शायद आप APT प्रारूप में दस्तावेज़ भी लिख सकते हैं?
लेकिन अधिक होने की संभावना आप doc, pdf और xls फ़ाइलें, ग्राफिक्स, ई-मेल, आदि का एक सेट है आप उन्हें /src/site के तहत जगह कर सकते हैं या तो साथ ही और साइट में हाइपरलिंक डाल या ... अपने स्वयं के सम्मेलन को परिभाषित , अफसोस की बात है। आमतौर पर मैंने /src/main/doc(s), /src/doc(s) या यहां तक कि /doc(s) देखा है।
आप /src/main/resources या src/main/webapp में अपने दस्तावेज़ जगह, के रूप में फाइल तो बनाया विरूपण साक्ष्य (जार/युद्ध) जो शायद ही कभी वांछित है का हिस्सा होगा नहीं करना चाहती।
स्रोत के बजाय स्रोत नहीं है? – Line
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
[..]
मुझे नहीं पता कि जोओओ ने वैकल्पिक सुझाव पोस्ट करने के बजाय इस पोस्ट को क्यों संपादित किया। वह साइट फ़ोल्डर के तहत संसाधन फ़ोल्डर रखता है जो निश्चित रूप से एक वैध विकल्प भी है। मैंने जो सुझाव दिया/उद्धृत किया है, वह स्रोत और साइट फ़ोल्डर्स के आगे शीर्ष स्तर पर एक संसाधन फ़ोल्डर का उपयोग करता है (पोस्ट में लिंक देखें)। कोई भी साइट पर सभी दस्तावेज शामिल नहीं करना चाहता है। – RobE
क्षमा करें @RobE, मेरी गलती। –
सिफारिश की गई है maven-javadoc-plugin के अनुसार:
<javadocDirectory/>पैरामीटर, अतिरिक्त संसाधनों, HTML या छवियों की तरह शामिल करने के लिए इस्तेमाल किया जा सकता उत्पन्न जावाडोक में। फिर आप इन संसाधनों को अपने जावाडोक टिप्पणियों में लिंक कर सकते हैं। डिफ़ॉल्ट रूप से, सभी javadoc संसाधन${basedir}/src/main/javadocनिर्देशिका में हैं। ध्यान दें कि इन्हें कॉपी करने के लिए आपकोdocfilessubdirsपैरामीटर सेट करने की आवश्यकता है।
क्या आप सामान्य और जावाडॉक में दस्तावेज़ों के बीच अंतर देखते हैं? :) – Line
कुछ हद तक। यदि आप जावाडोक को प्रारूप/दस्तावेज जनरेटर के रूप में देखते हैं, तो समस्या कभी भी एपीआई को दस्तावेज नहीं कर रही है, बल्कि उनके आसपास के दस्तावेज़ लिख रही है जो उनके उपयोग की व्याख्या करती है। उस * जावा * दस्तावेज़ों में, और एपीआई से जोड़ने, हमेशा एक अच्छा विचार प्रतीत होता है। यदि आप एपीआई की तुलना में कुछ * अन्य * दस्तावेज कर रहे हैं, तो मुझे लगता है कि कुछ और इस्तेमाल किया जा सकता है (उदा। मार्कडाउन)। – Alun
मैं '/ डॉक्स' के लिए मतदान होगा। '/ Src' के तहत सबकुछ मैवेन वर्ल्ड है, इससे बेहतर गड़बड़ नहीं है। मुझे यह भी लगता है कि प्रोजेक्ट स्वयं दस्तावेज को सहेजने के लिए अच्छा नहीं है। विकी स्थापित करने पर विचार करें। –
मेवेन में सभी स्रोत फाइलें/src के अंतर्गत जाती हैं। आपके द्वारा संपादित किए जाने वाले दस्तावेज़ स्रोत फ़ाइलें हैं, उन्हें कहीं/src के नीचे जाना चाहिए। यदि आप नई शीर्ष स्तरीय निर्देशिकाओं को जोड़ना शुरू करते हैं, तो आपकी परियोजना मेवेन सम्मेलनों का पालन नहीं कर रही है और दूसरों के लिए समझना मुश्किल होगा। –