Dart 주석 처리

Dart에서는 코드의 가독성을 높이고, 설명을 추가하기 위해 **주석(Comment)**을 사용할 수 있다.

Dart 주석은 3가지 종류가 있다.

1. 싱글 라인 주석 (//)
2. 멀티 라인 주석 (/* ... */)
3. 문서화 주석 (///)

이번 포스트에서는 Dart의 주석 처리 방법을 정리해본다.

 

📌 1. 싱글 라인 주석 (//)

• 한 줄짜리 주석을 작성할 때 사용한다.
• // 뒤에 오는 내용은 해당 줄 끝까지 Dart 컴파일러가 무시한다.

// calcuAB 함수는 두 개의 정수를 입력받아 계산.
int calcuAB(int A, int B) {
  return (A + B) * (A - B);
}

✅ // 뒤의 설명은 코드 실행에 영향을 주지 않는다.

 

📌 2. 멀티 라인 주석 (/* ... */)

• 여러 줄에 걸쳐 주석을 작성할 때 사용한다.
• /*로 시작하고 */로 끝나는 부분이 모두 주석으로 처리된다.

/*
  calcuAB 함수는 두 개의 정수를 입력받아 계산.
  [A], [B]는 모두 정수(int) 타입이어야 함.
*/
int calcuAB(int A, int B) {
  return (A + B) * (A - B);
}

✅ 긴 설명을 작성할 때 사용하면 좋다.

 

📌 3. 문서화 주석 (///)

• 클래스, 함수, 변수 등의 문서화를 위해 사용한다.
• ///를 여러 줄에 걸쳐 사용하면 멀티 라인 주석과 같은 효과를 낸다.
• 대괄호 [ ]를 사용하여 클래스, 메서드, 변수 등을 참조할 수 있다.

/// [CalculAB] 클래스는 두 개의 정수 값을 받는다.
/// 
/// - [A]: 첫 번째 정수 값
/// - [B]: 두 번째 정수 값
/// - [rtnCalcu]: 두 값을 계산하는 메서드
class CalculAB {
  int A;
  int B;

  // 생성자(Constructor)
  CalculAB(this.A, this.B);

  /// 두 개의 값을 계산하여 출력하는 메서드
  void rtnCalcu() {
    print((A + B) * (A - B));
  }
}

✅ 문서화 주석을 활용하면, 개발자가 작성한 코드를 쉽게 설명할 수 있다.

✅ [ ]를 사용하면 IDE에서 자동으로 참조 링크가 생성된다.

 

📌 주석 사용 시 주의할 점

 

1. 주석은 필요한 경우에만 작성한다.

• 너무 많은 주석은 오히려 가독성을 해칠 수 있다.
• 코드 자체로 이해하기 쉽다면 불필요한 주석은 생략한다.

2. 문서화 주석(///)은 공통 모듈, API 문서 등에 사용하면 좋다.

• 클래스, 함수, 변수 등을 설명하는 용도로 사용하면 효과적이다.

📌 Dart 공식 문서 참고

더 자세한 내용은 Dart 공식 문서에서 확인 가능.

주석