[초급] Dart 기본 문법/주석 작성하기: 코드의 가독성을 높이는 방법

 

주석은 코드에 대한 설명을 추가하여 가독성을 높이고, 코드의 동작이나 의도를 명확하게 전달하는 데 중요한 역할을 합니다. Dart에서도 주석을 효과적으로 사용하면, 코드 유지 보수성과 협업 효율성을 크게 향상시킬 수 있습니다.

이번 블로그에서는 Dart에서 주석을 작성하는 방법과 그 활용법을 초보자도 쉽게 이해할 수 있도록 설명하겠습니다.

1. Dart에서 주석이란?

주석은 프로그램에 영향을 주지 않으면서 코드에 대한 설명이나 메모를 추가하는 텍스트입니다. Dart에서는 두 가지 종류의 주석을 사용할 수 있습니다.

• 한 줄 주석: //로 시작하며, 해당 줄의 나머지 부분이 주석 처리됩니다.
• 여러 줄 주석: /* ... */로 감싸며, 여러 줄에 걸쳐 주석을 작성할 수 있습니다.

2. 한 줄 주석

한 줄 주석은 //를 사용하여 작성하며, 주로 짧은 설명이나 코드 라인 옆에 부연 설명을 달 때 사용됩니다.

예시: 한 줄 주석

void main() {
  int number = 10;  // 숫자 변수를 선언하고 초기화
  print(number);    // 변수 값을 출력
}

위 코드에서 각 줄의 끝에 있는 // 뒤의 텍스트가 주석입니다. 이 주석은 number 변수를 선언하고 초기화하는 목적과, 그 값을 출력하는 역할을 설명합니다.

3. 여러 줄 주석

여러 줄 주석은 /*로 시작해서 */로 끝납니다. 주로 긴 설명이나 여러 줄에 걸친 주석을 작성할 때 사용됩니다.

예시: 여러 줄 주석

/*
  이 함수는 두 숫자를 더한 값을 반환합니다.
  a: 첫 번째 숫자
  b: 두 번째 숫자
  반환값: 두 숫자의 합
*/
int add(int a, int b) {
  return a + b;
}

이 주석은 add 함수의 목적과 매개변수, 반환값에 대한 설명을 포함하고 있습니다. 여러 줄 주석은 코드의 시작 부분이나 함수 정의 앞에 전체적인 설명을 추가할 때 유용합니다.

4. 문서화 주석

Dart에서는 특별한 주석 형태로 문서화 주석을 사용할 수 있습니다. 문서화 주석은 ///로 시작하며, Dartdoc이라는 도구를 통해 자동으로 문서화할 수 있는 내용을 포함할 수 있습니다.

예시: 문서화 주석

/// 이 함수는 두 숫자를 더한 값을 반환합니다.
/// 
/// [a]: 첫 번째 숫자
/// [b]: 두 번째 숫자
/// 반환값: 두 숫자의 합
int add(int a, int b) {
  return a + b;
}

문서화 주석은 코드에 대한 보다 상세한 설명을 제공하며, 특히 라이브러리나 패키지를 개발할 때 다른 개발자들에게 유용한 정보를 제공하는 데 중요합니다.

5. 주석 작성 시의 모범 사례

• 의미 있는 주석 작성: 주석은 코드의 동작을 반복하지 않고, 왜 그렇게 동작하는지를 설명해야 합니다. 너무 단순하거나 명백한 내용은 주석을 달 필요가 없습니다.

// 잘못된 예시
int number = 10;  // number를 10으로 설정

// 올바른 예시
int retryLimit = 10;  // 사용자가 시도할 수 있는 최대 재시도 횟수

 

• 주석의 위치: 주석은 관련된 코드와 가깝게 배치하여, 코드와 주석이 자연스럽게 연결되도록 합니다.
• 코드 블록 앞에 주석 달기: 복잡한 코드 블록 앞에 주석을 추가하여, 그 코드가 어떤 작업을 수행하는지 간략히 설명합니다.

// 사용자 입력을 받아서 이름을 출력하는 코드
String userInput = getUserInput();
print('Hello, $userInput!');

 

• 문서화 주석 활용: 라이브러리나 공개 API를 작성할 때는 문서화 주석을 사용하여 다른 개발자들이 쉽게 이해할 수 있도록 설명을 추가합니다.

주석은 코드의 가독성을 높이고, 협업과 유지보수를 쉽게 하기 위한 중요한 도구입니다. Dart에서 주석을 올바르게 작성하는 방법을 이해하고 실천하면, 더 나은 코드 품질을 유지할 수 있습니다.

주석을 사용하는 연습을 통해, 코드의 의미와 의도를 명확하게 전달하는 능력을 길러보세요!

구독!! 공감과 댓글은 저에게 큰 힘이 됩니다.

Starting Google Play App Distribution! "Tester Share" for Recruiting 20 Testers for a Closed Test.

Tester Share [테스터쉐어] - Google Play 앱