Home > Archive > Post > πŸ“[blog post] Java Docs λ³΄λŠ” 방법.

πŸ“[blog post] Java Docs λ³΄λŠ” 방법.
Java Programming Language Backend blogging Documentation

πŸ“ Java Docsλ₯Ό μ½λŠ” λŠ₯λ ₯이 ν•„μš”ν•œ 이유. :)

μ €λŠ” Documentation이 κ·Έ μ–΄λ–€ 유λͺ… ν…Œν¬ λΈ”λ‘œκ±°μ˜ κΈ€ 보닀 μ€‘μš”ν•˜κ³  μ‹¬λ„μžˆκ²Œ 읽어야 ν•œλ‹€λŠ” 개인적인 의견이 μžˆμŠ΅λ‹ˆλ‹€.

κ·Έ μ΄μœ λŠ” Javaλ₯Ό κ°œλ°œν•œ κ°œλ°œμžλΆ„λ“€μ΄ 직접 λ§Œλ“  μ„€λͺ…μ„œλ‚˜ 닀름 μ—†κΈ° λ•Œλ¬Έμž…λ‹ˆλ‹€.

μš°λ¦¬κ°€ 레고λ₯Ό 생각해 λ΄…μ‹œλ‹€.

λ‚΄κ°€ μ’‹μ•„ν•˜λŠ” 레고λ₯Ό μ‚¬μ„œ μ§‘μ—μ„œ 쑰립할 λ•Œ 무엇을 λ³΄λ‚˜μš”? πŸ€”

λ§žμŠ΅λ‹ˆλ‹€!

레고 νŒ¨ν‚€μ§€ μ•ˆμ— λ“€μ–΄μžˆλŠ” β€œμ„€λͺ…μ„œβ€λ₯Ό 기반으둜 레고λ₯Ό μ‘°λ¦½ν•©λ‹ˆλ‹€.

레고λ₯Ό λ””μžμΈν•˜κ³  λ§Œλ“œμ‹  뢄이 직접 β€œμ΄λ ‡κ²Œ μˆœμ„œλŒ€λ‘œ λ§Œλ“€λ©΄ 당신이 μ›ν•˜λŠ” 멋진 레고 μ™„μ„±ν’ˆμ„ 얻을 수 μžˆμŠ΅λ‹ˆλ‹€!” λΌλŠ” 것을 직.κ°„μ ‘μ μœΌλ‘œ λ³΄μ—¬μ£ΌλŠ” μ•„μ£Ό μžμ„Έν•œ μ„€λͺ…이 λ“€μ–΄μžˆμ£  πŸ“

μ„€λͺ…μ„œλŠ” 직접 λ””μžμΈν•˜κ³  μ„€κ³„ν•œ μ‚¬λžŒμ˜ μ² ν•™κ³Ό 그듀이 μ™œ κ·Έλ ‡κ²Œ λ§Œλ“€μ—ˆλŠ”μ§€ 그리고 μ–΄λ–»κ²Œ μ“°μ—¬μ•Όν•˜λŠ”μ§€ μ •ν™•, λͺ…λ£Œν•˜κ²Œ λͺ…μ‹œλ˜μ–΄ μžˆμŠ΅λ‹ˆλ‹€.

λ˜ν•œ λ‹€λ₯Έ κ΅¬μ„±ν’ˆκ³Ό 맞좰볼 수 μžˆλŠ” 것도 μ œμ•ˆν•˜κ±°λ‚˜ 보여주기도 ν•©λ‹ˆλ‹€.

κ·Έλž˜μ„œ Documentation을 보고 μ œλŒ€λ‘œ ν™œμš©ν•  쀄 μ•„λŠ” 것이 κ°œλ°œμžμ—κ²ŒλŠ” μ€‘μš”ν•œ λŠ₯λ ₯ 쀑 ν•˜λ‚˜κ°€ μ•„λ‹κΉŒ ν•˜λŠ” 생각을 ν•©λ‹ˆλ‹€ πŸ™‹β€β™‚οΈ

1️⃣ Java Documentation 보기.

1. 온라인 λ¬Έμ„œ.

  • Java SE Documentation은 Oracle 곡식 μ‚¬μ΄νŠΈμ—μ„œ μ œκ³΅λ©λ‹ˆλ‹€.
    • Java 버전에 따라 λ‹€λ₯Έ λ¬Έμ„œκ°€ μ œκ³΅λ˜λ‹ˆ, μ‚¬μš©ν•˜λŠ” Java 버전에 λ§žλŠ” λ¬Έμ„œλ₯Ό 선택해야 ν•©λ‹ˆλ‹€.

2. IDE λ‚΄μž₯ λ¬Έμ„œ.

  • λ§Žμ€ 톡합 개발 ν™˜κ²½(IDE)μ—λŠ” JavaDoc을 μ‰½κ²Œ λ³Ό 수 μžˆλŠ” κΈ°λŠ₯이 λ‚΄μž₯λ˜μ–΄ μžˆμŠ΅λ‹ˆλ‹€. InteillJ IDEA, Eclipes, NetBeans λ“±μ—μ„œ μ½”λ“œ μž‘μ„± μ‹œ JavaDocsλ₯Ό λ³Ό 수 μžˆμŠ΅λ‹ˆλ‹€.
    • 예λ₯Ό λ“€μ–΄, IntelliJ IDEAμ—μ„œ ν΄λž˜μŠ€λ‚˜ λ©”μ†Œλ“œ 이름 μœ„μ— μ»€μ„œλ₯Ό 올리면 ν•΄λ‹Ή ν΄λž˜μŠ€λ‚˜ λ©”μ†Œλ“œμ˜ JavaDoc이 νŒμ—…μœΌλ‘œ ν‘œμ‹œλ©λ‹ˆλ‹€.

3. 둜컬 λ¬Έμ„œ.

  • Java JDKλ₯Ό μ„€μΉ˜ν•  λ•Œ, JavaDoc을 λ‘œμ»¬μ— λ‹€μš΄λ‘œλ“œν•  수 μžˆμŠ΅λ‹ˆλ‹€. 이λ₯Ό 톡해 인터넷 μ—°κ²° 없이도 λ¬Έμ„œλ₯Ό μ°Έμ‘°ν•  수 μžˆμŠ΅λ‹ˆλ‹€.
  • JDK μ„€μΉ˜ 경둜 μ•„λž˜μ˜ docs 폴더에 HTML ν˜•μ‹μ˜ λ¬Έμ„œκ°€ μ €μž₯λ˜μ–΄ μžˆμŠ΅λ‹ˆλ‹€.

2️⃣ Java Documentation ν™œμš© 방법

Java Documentation을 효과적으둜 ν™œμš©ν•˜λŠ” 방법을 μ•Œμ•„λ΄…μ‹œλ‹€.🀩

1. 클래슀 및 λ©”μ†Œλ“œ 탐색.

  • API λ¬Έμ„œμ—μ„œ νŒ¨ν‚€μ§€, 클래슀, λ©”μ†Œλ“œ, ν•„λ“œ λ“±μ˜ μ„ΈλΆ€ 정보λ₯Ό 탐색할 수 μžˆμŠ΅λ‹ˆλ‹€.
    • 예λ₯Ό λ“€μ–΄, java.util νŒ¨ν‚€μ§€μ— μ–΄λ–€ ν΄λž˜μŠ€κ°€ ν¬ν•¨λ˜μ–΄ μžˆλŠ”μ§€, ArrayList ν΄λž˜μŠ€μ— μ–΄λ–€ λ©”μ†Œλ“œκ°€ μžˆλŠ”μ§€ 등을 확인할 수 μžˆμŠ΅λ‹ˆλ‹€.

2. μ‚¬μš© 예제 μ°ΎκΈ°.

  • 각 ν΄λž˜μŠ€μ™€ λ©”μ†Œλ“œμ—λŠ” μ‚¬μš© μ˜ˆμ œκ°€ ν¬ν•¨λ˜μ–΄ μžˆμ„ 수 μžˆμŠ΅λ‹ˆλ‹€. μ΄λŸ¬ν•œ μ˜ˆμ œλŠ” ν•΄λ‹Ή APIλ₯Ό μ˜¬λ°”λ₯΄κ²Œ μ‚¬μš©ν•˜λŠ” 방법을 μ΄ν•΄ν•˜λŠ” 데 도움이 λ©λ‹ˆλ‹€.

3. λ©”μ†Œλ“œ μ‹œκ·Έλ‹ˆμ²˜ 및 μ„€λͺ….

  • λ©”μ†Œλ“œμ˜ λ§€κ°œλ³€μˆ˜, λ°˜ν™˜κ°’, μ˜ˆμ™Έ 등을 μ„€λͺ…ν•˜λŠ” μ‹œκ·Έλ‹ˆμ²˜μ™€ μ„€λͺ…을 톡해 λ©”μ†Œλ“œμ˜ μ‚¬μš©λ²•μ„ μ •ν™•νžˆ μ•Œ 수 μžˆμŠ΅λ‹ˆλ‹€.
    • 예λ₯Ό λ“€μ–΄, String 클래슀의 substring λ©”μ†Œλ“œμ˜ μ‹œκ·Έλ‹ˆμ²˜μ™€ μ„€λͺ…을 보면, λ§€κ°œλ³€μˆ˜λ‘œ 전달해야 ν•  κ°’κ³Ό λ°˜ν™˜λ˜λŠ” 값에 λŒ€ν•œ 정보λ₯Ό 얻을 수 μžˆμŠ΅λ‹ˆλ‹€.

4. 상속 ꡬ쑰 및 μΈν„°νŽ˜μ΄μŠ€.

  • ν΄λž˜μŠ€κ°€ κ΅¬ν˜„ν•˜λŠ” μΈν„°νŽ˜μ΄μŠ€μ™€ μƒμ†λ°›λŠ” ν΄λž˜μŠ€μ— λŒ€ν•œ 정보λ₯Ό 확인할 수 μžˆμŠ΅λ‹ˆλ‹€. 이λ₯Ό 톡해 클래슀의 κΈ°λŠ₯을 ν™•μž₯ν•˜κ±°λ‚˜ μΈν„°νŽ˜μ΄μŠ€λ₯Ό κ΅¬ν˜„ν•˜λŠ” 방법을 이해할 수 μžˆμŠ΅λ‹ˆλ‹€.

3️⃣ 예제

λ‹€μŒμ€ Java Documentation을 ν™œμš©ν•˜λŠ” λͺ‡ 가지 μ˜ˆμ œμž…λ‹ˆλ‹€.

예제 1: ArrayList 클래슀의 λ©”μ†Œλ“œ μ‚¬μš©λ²• 확인 πŸ™‹β€β™‚οΈ

  1. 온라인 λ¬Έμ„œμ—μ„œ ArrayList 클래슀λ₯Ό μ°ΎμŠ΅λ‹ˆλ‹€.
    • Java SE Documentationμ—μ„œ java.util.ArrayList λ₯Ό κ²€μƒ‰ν•©λ‹ˆλ‹€.
    • ArrayList 클래슀의 API λ¬Έμ„œλ₯Ό μ—΄μ–΄ λ©”μ†Œλ“œ λͺ©λ‘μ„ ν™•μΈν•©λ‹ˆλ‹€.
  2. add(E e) λ©”μ†Œλ“œ μ‚¬μš©λ²• ν™•μΈν•˜κΈ°.
    • add(E e) λ©”μ†Œλ“œλŠ” 리슀트의 끝에 μš”μ†Œλ₯Ό μΆ”κ°€ν•˜λŠ” λ©”μ†Œλ“œμž…λ‹ˆλ‹€.
    • λ©”μ†Œλ“œ μ„€λͺ…을 읽고, 예제λ₯Ό ν™•μΈν•˜μ—¬ μ‚¬μš©λ²•μ„ μ΄ν•΄ν•©λ‹ˆλ‹€.

예제 2. String 클래슀의 substring λ©”μ†Œλ“œ μ‚¬μš©λ²• 확인 πŸ™‹β€β™‚οΈ

  1. IDE λ‚΄μž₯ λ¬Έμ„œ ν™œμš©ν•˜κΈ°.
    • IntelliJ IDEAλ‚˜ Eclipseμ—μ„œ String 클래슀의 substring λ©”μ†Œλ“œλ₯Ό μ‚¬μš©ν•˜λ €κ³  ν•  λ•Œ, λ©”μ†Œλ“œ 이름 μœ„μ— μ»€μ„œλ₯Ό 올리면 JavaDoc이 ν‘œμ‹œλ©λ‹ˆλ‹€.
    • JavaDoc을 톡해 substring(int beingIndex, int endIndex) λ©”μ†Œλ“œμ˜ λ§€κ°œλ³€μˆ˜μ™€ λ°˜ν™˜ 값에 λŒ€ν•œ μ„€λͺ…을 μ½μŠ΅λ‹ˆλ‹€.
public class Main {
    public static void main(String[] args) {
        String text = "Hello, World!";
        String subText = text.substring(7, 12); // "World"
        System.out.println(subText);
    }
}

μœ„ μ˜ˆμ œμ—μ„œ substring λ©”μ†Œλ“œμ˜ λ§€κ°œλ³€μˆ˜κ°€ beginIndex 와 endIndex μž„μ„ μ•Œ 수 있으며, μ΄λŠ” μ‹œμž‘ μΈλ±μŠ€λΆ€ν„° μ’…λ£Œ 인덱슀 μ „κΉŒμ§€μ˜ λ¬Έμžμ—΄μ„ λ°˜ν™˜ν•©λ‹ˆλ‹€.

예제 3. μ˜ˆμ™Έ 처리 방법 확인 πŸ™‹β€β™‚οΈ

  1. μ˜ˆμ™Έ 클래슀 λ¬Έμ„œ ν™•μΈν•˜κΈ°.
    • java.lang.NullPointerException 클래슀의 λ¬Έμ„œλ₯Ό ν™•μΈν•˜μ—¬ μ–Έμ œ 이 μ˜ˆμ™Έκ°€ λ°œμƒν•˜λŠ”μ§€, 그리고 이λ₯Ό μ–΄λ–»κ²Œ μ²˜λ¦¬ν•  수 μžˆλŠ”μ§€μ— λŒ€ν•œ 정보λ₯Ό μ–»μŠ΅λ‹ˆλ‹€.
  2. μ˜ˆμ™Έ 처리 예제
public class Main {
    public static void main(String[] args) {
        try {
            String text = null;
            System.out.println(text.length());
        } catch (NullPointerException e) {
            System.out.println("Caught a NullPointerException");
        }
    }
}

이 μ˜ˆμ œλŠ” NullPointException 이 λ°œμƒν•  λ•Œ 이λ₯Ό μ²˜λ¦¬ν•˜λŠ” 방법을 λ³΄μ—¬μ€λ‹ˆλ‹€.

πŸ“ μš”μ•½.

  • Java Documentation은 Java APIλ₯Ό μ΄ν•΄ν•˜κ³  μ‚¬μš©ν•˜λŠ” 데 ν•„μˆ˜μ μΈ μžλ£Œμž…λ‹ˆλ‹€.
  • Java Documentationλ₯Ό 온라인, IDE, λ˜λŠ” λ‘œμ»¬μ—μ„œ μ ‘κ·Όν•  수 μžˆμŠ΅λ‹ˆλ‹€.
  • API λ¬Έμ„œλ₯Ό 톡해 ν΄λž˜μŠ€μ™€ λ©”μ†Œλ“œμ˜ μ„ΈλΆ€ 정보λ₯Ό ν™•μΈν•˜κ³ , 예제λ₯Ό μ°Έκ³ ν•˜μ—¬ μ˜¬λ°”λ₯΄κ²Œ μ‚¬μš©ν•˜λŠ” 방법을 배울 수 μžˆμŠ΅λ‹ˆλ‹€.
  • 상속 ꡬ쑰와 μΈν„°νŽ˜μ΄μŠ€ κ΅¬ν˜„ 방법을 μ΄ν•΄ν•˜μ—¬ μ½”λ“œμ˜ μž¬μ‚¬μš©μ„±κ³Ό ν™•μž₯성을 높일 수 μžˆμŠ΅λ‹ˆλ‹€.