주석문

주석문

@2024.03.12

우리가 프로그래밍을 하다 보면 해당 코드에 대한 설명을 적어놓는 것이 굉장히 중요하다.

코드가 길어지면, 가독성이 떨어져 내가 짠 코드를 나도 못 알아볼 때가 많고, 다른 사람이 나의 코드

를 볼 때도 설명을 잘 작성해야지 이해하기가 쉽다.

주석문이란?

💡

실제 프로그램에는 영향을 주지 않고, 코드에 대한 설명을 작성할 때 사용한다.

• 본인 혹은 다른 사람이 코드를 봤을 때 프로그램 내용을 빨리 파악할 수 있도록 돕기 위해 사용

주석 기호

💡

1. // : //부터 시작해서 줄 끝까지 주석 처리

💡

2. /*……*/ : /*와 */ 사이의 내용 모두 주석 처리

💡

/**…*/(Javadoc) : 코드의 API 문서를 생성하는데 사용하며, /**와 */ 사이의 내용을 모두 주석처리

• Javadoc 주석에서 자주 사용하는 태그
  • @version : 클래스나 메서드의 버전
  • @author : 작성자
  • @deprecated : 더 이상 사용되지 않거나 삭제될 예정
  • @since : 언제 생성, 추가되었는지
  • @see : 외부 링크나 텍스트, 다른 필드나 메서드를 링크할 때 사용
  • @link : see와 동일한 기능, 링크 제공
  • @exception : 발생할 수 있는 Exception 정의