다트 언어 주석 3가지 using dart comment

프로그래밍 언어에서 주석은 코드에 대한 설명을 적어 목적과 사용방법 등을 표기해 둔다. 주석을 잘 작성해 놓음으로써 추후 메서드의 용도 등을 다시 파악할 수도 있고, 다른 사람이 볼 때도 코드를 금방 파악할 수 있도록 할 수 있다. 다트 언어에서 사용하는 주석은 한줄주석, 여러줄주석, html문서주석으로 3가지 방법으로 사용할 수 있다.

다트 언어 주석 3가지
using dart comment

주석은 개발된 코드의 설명을 작성해 두고 변수나 메서드 함수 등의 사용 용도를 간략히 적어두는 것이다.

혹여 다른 사람이 코드를 처음 보게 될 경우 빠르게 이해하도록 하는 것이기도 하며, 코드의 수정이 있을 경우 어떤 부분을 고쳐야 하는지를 파악할 수 있다.

물론, 주석을 어떻게 사용하는지에 따라 다르겠지만 현업에서는 공통된 양식이 존재한다.

다트 언어에서 사용하는 주석은 3가지가 있는데 한줄 주석, 여러줄 주석, 문서 생성 주석이 있다.

주석 comment

주석은 설명문과 같다.

코드에서 사용한 변수나 함수 등에 기능과 동작, 목적 등에 대한 내용을 간단히 작성해 둔다.

기록은 기억을 지배한다고 했던가.

굳이 길고 장황하게 적어 둘 필요까지는 없지만 어떤 목적에 사용되는지 간단히 적어두는 것은 중요할 수 있다.

아래는 주석을 사용하는 3가지 방법이다.

• // 한줄주석
  간단한 설명이나 명사 등을 적는다.
• /* ~ */ 여러 줄 주석
  한줄이상 여러줄로 설명을 적기 위해 사용한다.
• /// html 문서 주석
  주석의 내용을 html 문서로 만든다.

// 한줄 주석

/*
 여러 줄 주석
 여러 줄 주석
*/

/// html 문서 주석
/// html 문서 주석

샘플코드

주석의 사용은 간단하다.

코드의 설명을 작성해 주면 되고, 간단히 작성할 때는 한줄 주석을 사용한다.

여러 줄이 필요할 경우 여러 줄 주석을 사용하면 된다.

만약, 코드에 대해 별도의 html 문서로 만들 필요가 있다면 html 문서 주석을 사용한다.

• // 한줄주석
• /* ~ */ 여러줄 주석
• /// html 문서 주석

// 코드의 실행은 단축키 F5 이다.
/// 함수를 만들고 호출하여 함수를 실행한다.
/// 함수의 내용은 사칙연산과 나머지연산에 대해 각각 함수를 만든다.
/// 만들어진 함수는 호출하고 출력문을 통해 실행 테스트를 해 본다.
void main() {
  /**
   * 사칙연산과 나머지연산에 대한 함수를 만들고 호출해 본다.
  */

  // 덧셈 함수
  fnAddtion();
  // 뺄셈 함수
  fnSubtraction();
  // 곱셈 함수
  fnMultiplication();
  // 나눗셈 함수
  fnDivision();
  // 나머지 함수
  fnReminder();
}

void fnAddtion() {
  print('더하기');
}

void fnSubtraction() {
  print('빼기');
}

void fnMultiplication() {
  print('곱하기');
}

void fnDivision() {
  print('나누기');
}

void fnReminder() {
  print('나머지');
}