كيفية الرجوع إلى javadocs إلى التبعيات في البرنامج المساعد Maven's Eclipse عندما لا يكون javadoc مرتبطًا بالتبعية

StackOverflow https://stackoverflow.com/questions/44396

  •  09-06-2019
  •  | 
  •  

سؤال

أستخدم Eclipse وMaven وJava في تطويري.أستخدم Maven لتنزيل التبعيات (ملفات jar وjavadoc عند توفرها) والمكونات الإضافية لـ Maven Eclipse لإنشاء ملفات .project و.classpath لـ Eclipse.عندما لا تحتوي التبعية التي تم تنزيلها على javadoc مرفقًا، أقوم يدويًا بإضافة رابط لـ javadoc في ملف .classpath حتى أتمكن من رؤية javadoc للتبعية في Eclipse.ثم عندما أقوم بتشغيل البرنامج المساعد Maven's Eclipse لإعادة إنشاء ملف .classpath، فإنه بالطبع يمسح هذا التغيير.

هل هناك طريقة لتكوين البرنامج الإضافي لـ Maven's Eclipse لإضافة سمات classpath تلقائيًا لـ javadoc عند تشغيل البرنامج الإضافي لـ Maven's Eclipse؟

أنا مهتم فقط بالإجابات التي لا يتم فيها توفير javadoc و/أو المصادر للتبعية في مستودع maven، وهو ما يحدث في أغلب الأحيان بالنسبة لي.لن يساعد استخدام خصائص downloadSources و/أو downloadJavadocs في حل هذه المشكلة.

هل كانت مفيدة؟

المحلول

قد تفكر في تجنب هذه المشكلة تمامًا عن طريق تثبيت javadoc jar في مستودعك المحلي يدويًا باستخدام ملف هدف تثبيت الملف وتمرير الخيار -Dclassifier=javadoc.بمجرد القيام بذلك، يجب أن يكون مسار .classpath الذي ينشئه mvn صحيحًا.

إذا كنت تستخدم الريبو عن بعد كوكيل للمركز المركزي، فيمكنك أيضًا نشر javadocs إلى هذا الريبو ومن ثم سيحصل الآن أي شخص آخر يستخدم هذا الوكيل على javadocs تلقائيًا أيضًا.

نصائح أخرى

من البرنامج المساعد Maven Eclipse التعليمات

يوضح المثال التالي كيفية القيام بذلك في سطر الأوامر:

mvn eclipse:eclipse -DdownloadSources=true  -DdownloadJavadocs=true 

أو في pom.xml الخاص بك:

<project>
  [...]
  <build>
    [...]
    <plugins>
      [...]
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-eclipse-plugin</artifactId>
        <configuration>
          <downloadSources>true</downloadSources>
          <downloadJavadocs>true</downloadJavadocs>
        </configuration>
      </plugin>
      [...]
    </plugins>
    [...]
  </build>
  [...]
</project>

أنا أقوم بتشغيل STS 2.8.1 وهو في الأساس أدوات Eclipse + Spring؛في مشروع maven موجود، قمت بالنقر بزر الماوس الأيمن على المشروع -> maven -> تنزيل المصادر وتنزيل JavaDocs

كما ذكر في كيفية تنزيل المصادر وعناصر javadoc باستخدام البرنامج المساعد Maven Eclipse من مستودع آخر؟, ، انت تستطيع فعل ذالك:

في Eclipse، انتقل إلى Windows-> التفضيلات-> Maven.حدد المربع الذي يقول "قم بتنزيل Artifact Javadoc." لقد عملت بشكل جيد بالنسبة لي.

Maven Preferences

بشكل عام، لا يتم استخدام Javadocs بشكل أساسي كتبعية.لأن هذه ليست مطلوبة في الترجمة أو وقت التشغيل.إنها فقط لمساعدة المطور أثناء التطوير أو التصحيح.

بافتراض استخدام Java IDE Eclipse، يمكننا استخدام مستندات Java كما هو مشار إليه.فيما يلي الطرق التي يمكننا من خلالها ربط javadocs/sources مع الجرار المعنية.

1.إذا كان مشروعًا غير مخضرم:

قم بتنزيل ملف javadocs jar أو الملف المضغوط، مهما كان متاحًا، ثم ضعه في دليل ما.انقر بزر الماوس الأيمن على مشروع التطبيق في IDE Eclipse، وانقر فوق خصائص واختر Java Build Path ثم حدد علامة التبويب Libraries ضمن Java Build Path.الآن قم بتوسيع الجرة التي تريد ربطها بمستندات/مصدر Java.حدد رابط موقع Javadoc وانقر على زر "تحرير"، وستظهر نافذة جديدة حيث نحتاج إلى اختيار مسار javadocs jar.انقر فوق "موافق" وقمنا بربط javadoc/source مع الجرار المعنية.

enter image description here

2.إذا كان مشروعًا مخضرمًا

إذا كنا نستخدم مشروع Maven، فانتقل إلى ملفات jar ضمن تبعية Maven ضمن المشروع في عرض Project Explorer كما هو موضح أدناه.الآن انقر بزر الماوس الأيمن على ملف الجرة الذي تريد إضافة Javadoc/source إليه،  اختر Maven ثم انقر على Javadoc أو المصدر الذي تريد ربطه بالمشروع.الآن سيقوم IDE تلقائيًا بتنزيل javadoc/source المطلوب وسيقوم بربطه بالجرة المعنية في المشروع.

enter image description here

يمكنك التحقق من ذلك عن طريق النقر بزر الماوس الأيمن على المشروع في IDE والنقر فوق Java Build Path وتحديد علامة التبويب Libraries ضمن Java Build Path ثم قم بتوسيع الجرة المطلوبة، هنا عند النقر فوق الزر "تحرير" سترى المسار المرتبط بـ Javadoc/Source مع الجرة المعنية كما هو موضح أدناه في الصورة.

enter image description here

3.إذا كان مشروع Maven وقمنا بتعيين السلوك الافتراضي:

سيقوم Eclipse بتنزيل javadoc/source بشكل مائي مع الجرة الرئيسية المطلوبة في البداية.افتراضيًا، قم بتعيين التعليمات إلى Maven لتنزيل Javadoc/sources لجميع الجرار المرتبطة بالمشروع.

انقر فوق Windows - التفضيلات - حدد Maven وانقر فوق مربع الاختيار Download Artifact Javadoc كما هو موضح أدناه

enter image description here

انقر الآن على "تطبيق" واحفظه، والآن عندما تقوم بإنشاء مشروع Maven جديد، سيتم تنزيل Javadocs افتراضيًا وربطه بجميع الجرار التابعة في المشروع.
يمكنك التحقق من خلال النقر بزر الماوس الأيمن على المشروع والخصائص، وتحت مسار Java Build، يمكنك رؤية javadocs مرتبطة بجميع الجرار كما هو موضح أدناه.

enter image description here

إذا كان مشروعك هو مشروع Maven، فمن الأفضل دائمًا استخدام النهج الثاني لأنه باستخدام هذا الأسلوب، يعتني IDE وMaven بتنزيل الإصدار الصحيح من Javadoc/source وربطه بالجرة النسبية أيضًا.

النهج الثالث مكلف بعض الشيء لأنه سيتم تنزيل javadoc/sources لجميع الجرار التابعة، ربما لا تكون مهتمًا بـ javadocs/sources لجميع الجرار التابعة.

هل وجود مصادر التبعية سيساعد؟يمكنك إخبار البرنامج المساعد Eclipse بتنزيل تلك العناصر (والرجوع إليها في .classpath) باستخدامها -DdownloadSources=true

مرخصة بموجب: CC-BY-SA مع الإسناد
لا تنتمي إلى StackOverflow
scroll top