자바 - 계산기 클래스 + 자바독(자바문서) 만들기

[ 자바독 (자바 도큐먼트) : 자바 문서 ]

★자바 클래스마다 문서를 만들어 두면, 선배들이 좋아한다.

• 적는 이유는 나와 남들에게 보여주기 위함.
• '자바독(자바 도큐먼트 = 자바 문서)'이라고 함
• 만드는 방법은 ' /** ' 를 적는다.

---

[ 클래스 자바독 만들기 ]

/**
 *  (클래스 설명)
 * 
 * 
 * @author(저자)     홍길동(이름)
 * @since(만든 날짜) 2023.07.19
 * @version 1.0.0 (버젼)
 *
 */

---

[ 적용 ]

/**
 * 
 * 덧셈, 뺄셈, 곱셈, 나눗셈 기능을 제공하는 계산기 클래스
 * 
 * @author  홍길동
 * @since   2023.07.19
 * @version 1.0.0
 *
 */

---

public class Calculator {

[ 메소드 자바독 만들기 ]

/*
 /**
  * 
  * (메소드 설명)
  * 
  * @param a 설명
  * @param b 설명
  * @return 설명
  */

---

[ 적용 ]

- 덧셈 메소드 -

/**
  * 
  * 실수 2개를 전달 받아서 그 합을 반환하는 메소드
  * 
  * @param a 실수
  * @param b 실수
  * @return 파라미터 2개의 덧셈 결과
  */
 public double addition(double a, double b) {
   return a + b;
 }

- 뺄셈 메소드 -

/**
  * 
  * 실수 2개를 전달 받아서 그 뺄셈을 반환하는 메소드
  * 
  * @param a 실수
  * @param b 실수
  * @return 파라미터 2개의 뺄셈 결과
  */
 public double subtraction(double a, double b) {
   return a - b;
 }

- 곱셈 메소드 -

/**
 * 
 * 실수 2개를 전달 받아서 그 곱셈을 반환하는 메소드
 * 
 * @param a 실수
 * @param b 실수
 * @return 파라미터 2개의 곱셈 결과
 */
public double multiplication(double a, double b) {
  return a * b;
}

- 나눗셈 메소드 -

/**
  * 
  * 실수 2개를 전달 받아서 그 나눗셈을 반환하는 메소드
  * 
  * @param a 실수
  * @param b 실수
  * @return 파라미터 2개의 나눗셈 결과
  */
 public double division(double a, double b) {
   return a / b;
 }

---

[ 정리 ]

만든 계산기는 실제 계산기가 아니라
계산기의 설계도를 만든 것이다.
설계도 만으로는 실제 계산이 안 된다.
(설계도는 실행해도 아무 일도 일어나지 않는다.)

실제로 만져서 사용할 수 있는 건 '객체'이다.
이제 설계도를 보고 계산기를 만들어야 하는데,
이것을 클래스(설계도)를 보고 객체(실물)를 만든다고 한다.
ex) 붕어빵틀(클래스) , 붕어빵(객체)

클래스 안에 있는 메소드를 호출하고 싶으면,
클래스를 먼저 객체로 만들고
그 객체를 이용해서 메소드를 호출한다.**

---

[ 클래스(설계도)로 객체(실물) 만들기 ]

public static void main(String[] args) {

// Calculator 객체 만들기
    
    // Calculator 객체 선언
    // 클래스의 이름이 객체의 타입이다.
    //  타입  객체이름
    Calculator myCalc;
    
    // Calculator 객체 생성
    myCalc = new Calculator();
    // ↑ 이것이 손으로 만질 수 있는 실제 계산기.
    
    
    // 계산하고자 하는 실수 2개 준비
    double a = 1.5;
    double b = 1.2;

    // 덧셈, 뺄셈, 곱셈, 나눗셈 메소드 호출
    System.out.println(myCalc.addition(a, b));
    System.out.println(myCalc.subtraction(a, b));
    System.out.println(myCalc.multiplication(a, b));
    System.out.println(myCalc.division(a, b));
}

• 자동 완성에 보면 Calculator(내가 만든 클래스(설계도) 이름) 라고 적혀있는 것들이 내가 만든 기능들.