Dart. Коменттер

Dart бір жолды коммент, көп жолды коммент және құжаттама комменттерін қолдайды.

Бір жолды коммент

Бір жолды коммент // белгілерімен басталады. // белгісінен жолдың соңына дейін Dart компиляторы оқымайды.

void main() {
  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 классының құжаттамасына нұсқайтын сілтемеге айналады