다트] 한 줄 주석, 여러 줄 주석, 문서 주석

한 줄 주석

한 줄 주석은 // 로 시작한다. 다트 컴파일러는 // 의 시작부터 줄 끝 사이의 모든 내용을 무시한다.

// 한 줄 주석

 

 

 

여러 줄 주석

여러 줄 주석은 /* 로 시작해서 */ 로 끝난다. /* 과 */ 사이의 모든 것은 무시된다.

 

하지만 문서 주석인 경우에는 무시되지 않는다. 여러 줄 주석은 중첩될 수도 있다.

/*
 * 여러 줄 주석
 */

​

 

 

문서 주석

문서 주석은 여러 줄 또는 한 줄 주석이 있다.

• 여러 줄 주석 : /** 과 **/
• 한 줄 주석 : ///

문서 주석 내에서 분석기는 대괄호로 묶이지 않는 모든 텍스트를 무시한다. 대괄호를 사용하여 클래스, 메서드, 속성, 최상위 변수, 함수 및 매개변수를 참조할 수 있다. 대괄호 안에 이름은 문서화 프로그램 요소의 어휘 범위에서 확인된다.

 

다음은 다른 클래스의 인수에 대한 참조가 있는 문서 주석의 예이다.

/// A domesticated South American camelid (Lama glama).
///
/// Andean cultures have used llamas as meat and pack
/// animals since pre-Hispanic times.
///
/// Just like any other animal, llamas need to eat,
/// so don't forget to [feed] them some [Food].
class Llama {
  String? name;

  /// Feeds your llama [food].
  ///
  /// The typical llama eats one bale of hay per week.
  void feed(Food food) {
    // ...
  }

  /// Exercises your llama with an [activity] for
  /// [timeLimit] minutes.
  void exercise(Activity activity, int timeLimit) {
    // ...
  }
}

 

[feed]는 feed 메서드에 대한 문서의 링크가 되고, [Food]는 Food 클래스에 대한 문서에 대한 링크가 된다. 다트 문서 생성 도구로는 dartdoc이 있다.

​