Java - 주석문 [ 즐거운 자바 강좌 ]

🏁 주석문

• 프로그래밍 실행과는 상관없는 문장
• 프로그램에 설명을 붙이기 위해 사용

🏁 종류

• JavaDoc 주석문
  : 클래스 메서드 필드 설명하기 위해 적는다.
  
  • IntelliJ에서 JavaDoc 생성하기
    • shift키를 2번 연속 누른다.
    • generate javaDoc을 입력한다.
    • custom scope를 선택한 후, JavaDoc을 생성할 패키지, 클래스, 인터페이스 등을 선택한다.
      exclude를 선택해서 생성하지 않을 것들도 지정할 수 있다.
    • output directory에서 Java Doc이 생성할 경로를 지정한다.
    • other command line arguments에는 다음을 입력한다.
      
    • OK 버튼 클릭한다.
      🚩 이렇게 내 API를 만들 수 있다.

🏁 주석문을 잘 작성하는 방법은?

• 주석문이 없어도 이해할 수 있도록 클래스, 메소드, 변수 이름을 작성한다.
• 주석문은 최소한으로 작성한다.
• JavaDoc주석문을 잘 작성한다.