הורד מקורות ו- Javadocs עם Maven

1. סקירה כללית

הצצה לקוד המקור ולתיעוד של ספריות ומסגרות שונות היא דרך טובה ללמוד עליהם יותר.

במדריך קצר זה נראה כיצד להגדיר את Maven, או לבקש מ Maven, להוריד עבורנו את מקורות התלות ואת ה- Javadoc שלהם.

2. שורת פיקוד

כברירת מחדל, Maven מוריד רק את קובץ ה- JAR בפועל של כל תלות, לא את מקורות וקבצי התיעוד.

להורדת המקורות בלבדראשית, עלינו נווט לספרייה המכילה את pom.xml ואז בצע את הפקודה:

תלות mvn: מקורות

ייתכן שייקח זמן להוריד את המקורות. בדומה לכך, כדי להוריד רק את ה- Javadocs, אנחנו יכולים להוציא את הפקודה:

תלות mvn: לפתור -Dclassifier = javadoc

כמובן, אנו יכולים להוריד את שניהם גם בפקודה אחת:

תלות mvn: תלות במקורות: לפתור -Dclassifier = javadoc

ברור שאם נוסיף תלות חדשה לאחר הנפקת פקודות אלה, עלינו להנפיק מחדש את הפקודות להורדת מקורות ו- Javadoc לתלות החדשה.

3. הגדרות Maven

ניתן גם להוריד מקורות ותיעוד בכל מערכת הפרויקטים בכל Maven. לשם כך עלינו לערוך את ~ / m2 / settings.xml קובץ או צור אחד והוסף אליו את התצורה הבאה:

    אמיתית אמיתית 

כפי שמוצג לעיל, אנו יוצרים פרופיל ומפעילים אותו כברירת מחדל. בפרופיל זה אנו מגדירים שני מאפיינים המורים ל- Maven להוריד מקורות ותיעוד. יתר על כן, מייבן תחיל הגדרות אלה על כל הפרויקטים.

4. ה pom.xml

אפשר אפילו להכניס תצורה זו אל ה- pom.xml. בדרך זו אנו מכריחים את כל תורמי הפרויקט להוריד מקורות ותיעוד כחלק מרזולוציית התלות:

   org.apache.maven.plugins maven-dependency-plugin 3.1.2 מקורות פותרים javadoc 

הנה, אנו מגדירים את תוסף maven-dependency להורדת המקורות והתיעוד.

5. התקנת IDE

אנו יכולים גם להגדיר את ה- IDE המועדפים עלינו שיעשו זאת עבורנו. לדוגמה, ב- IntelliJ IDEA, אנחנו רק צריכים ללכת ל העדפה> בנייה, ביצוע, פריסה> כלי בנייה> Maven> ייבוא וסמן את תיבות הסימון של המקורות והתיעוד:

6. מסקנה

במדריך מהיר זה ראינו כיצד ניתן להוריד מקורות תלות ותיעוד ב- Maven במגוון דרכים, החל בפתרונות שורת פקודה וכלה בתצורות לכל פרויקט או תצורה רחבה של המערכת.


$config[zx-auto] not found$config[zx-overlay] not found