Dart, 설명문/주석

Dart, 설명문/주석

 

글, 수알치 오상문

 

dart는 한 줄, 여러 줄, 문서 주석을 지원합니다.

 

한 줄 설명문

 

한 줄 주석은 //로 시작합니다.

// 이후 내용은 Dart 컴파일러가 무시합니다.

 

void main() {

  // TODO: refactor into an AbstractLlamaGreetingFactory?

  print('Welcome to my Llama farm!'); }

 

여러 줄 설명문

 

여러 줄 주석은 / *로 시작하고 * /로 끝납니다.

/ *와 * / 사이의 모든 것은 Dart 컴파일러가 무시합니다. 여러 줄 주석은 중첩 될 수 있습니다.

 

void main() {

/*

 * This is a lot of work. Consider raising chickens. 

 

 Llama larry = Llama();

 larry.feed();

 larry.exercise();

 larry.clean();

*/

}

 

문서 설명문

 

문서(문서용) 주석은 /// 또는 /**로 시작하는 여러 줄 또는 한 줄 주석입니다. 연속 줄에 ///를 사용하면 여러 줄 문서 주석과 같은 효과가 있습니다. 문서 주석 내에서 분석기는 대괄호로 묶이지 않는 한 모든 텍스트를 무시합니다. 대괄호를 사용하여 클래스, 메서드, 필드, 최상위 변수, 함수 및 매개 변수를 참조 할 수 있습니다. 괄호 안의 이름은 문서화 된 프로그램 요소의 어휘 범위에서 확인됩니다. 다음은 다른 클래스 및 인수에 대한 참조가있는 문서 주석의 예입니다.

 

/// 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 클래스 문서에 대한 링크가됩니다.

 

<이상>