В чем разница между // и /// во флаттере

Я просто комментировал свое приложение, так как узнал, что вы можете использовать разные комментарии. Мне любопытно, есть ли какие-то правила комментирования для этого или это как-то связано с автоматическим комментированием флаттера?

Мой выбор в пользу ///, так как цвет другой, поэтому лучше посмотреть, что я прокомментировал и что сделал флаттер.

Это заставляет меня задаться вопросом, почему есть два разных способа комментировать

//  <-- This is a way
/// <-- This is a way

заранее спасибо

// -> Обозначает однострочный комментарий & /// -> Комментарий к документации. Чтобы узнать больше: dart.dev/guides/language/efficient-dart/documentation

Prashant 26.01.2023 08:33
Стоит ли изучать PHP в 2026-2027 годах?
Стоит ли изучать PHP в 2026-2027 годах?
Привет всем, сегодня я хочу высказать свои соображения по поводу вопроса, который я уже много раз получал в своем сообществе: "Стоит ли изучать PHP в...
Поведение ключевого слова "this" в стрелочной функции в сравнении с нормальной функцией
Поведение ключевого слова "this" в стрелочной функции в сравнении с нормальной функцией
В JavaScript одним из самых запутанных понятий является поведение ключевого слова "this" в стрелочной и обычной функциях.
Приемы CSS-макетирования - floats и Flexbox
Приемы CSS-макетирования - floats и Flexbox
Здравствуйте, друзья-студенты! Готовы совершенствовать свои навыки веб-дизайна? Сегодня в нашем путешествии мы рассмотрим приемы CSS-верстки - в...
Тестирование функциональных ngrx-эффектов в Angular 16 с помощью Jest
В системе управления состояниями ngrx, совместимой с Angular 16, появились функциональные эффекты. Это здорово и делает код определенно легче для...
Концепция локализации и ее применение в приложениях React ⚡️
Концепция локализации и ее применение в приложениях React ⚡️
Локализация - это процесс адаптации приложения к различным языкам и культурным требованиям. Это позволяет пользователям получить опыт, соответствующий...
Пользовательский скаляр GraphQL
Пользовательский скаляр GraphQL
Листовые узлы системы типов GraphQL называются скалярами. Достигнув скалярного типа, невозможно спуститься дальше по иерархии типов. Скалярный тип...
2
1
57
4
Перейти к ответу Данный вопрос помечен как решенный

Ответы 4

Согласно Эффективному дротику,

// для однострочного комментария, как внутри функции

/// для многострочных (хотя однострочные тоже поддерживаются) комментариев к документации, как у вас над определением функции.

Ответ принят как подходящий

Во Flutter // используется для создания однострочного комментария, который игнорируется компилятором Dart.

/// используется для создания комментария к документации, который можно использовать для создания документации для вашего кода с помощью инструмента dartdoc. Этот тип комментариев также игнорируется компилятором Dart, но его можно использовать для предоставления дополнительной информации о классе, функции или переменной разработчикам, читающим код.


Пример:

/// This is a documentation comment for a function
void myFunction() {
  // this is a single-line comment
}

Когда вы используете инструмент dartdoc, он извлекает комментарии из кода и создает документацию в формате HTML.

В дополнение к этому обратитесь к официальной документации о dartdocguides-documenting-dart-libraries . Для использования и примеров обратитесь к guides-dartdoc

// для однострочного комментария, как внутри функции

/// используется для многострочных комментариев к документации, как у вас над определением функции.

Dart поддерживает три вида комментариев:

// Inline comments

/*
Blocks of comments. It's not convention to use block comments in Dart.
*/

/// Documentation
///
/// This is what you should use to document your classes.

Также могу дать вам хорошую подсказку

// TODO: some words

Другие вопросы по теме