Я просто комментировал свое приложение, так как узнал, что вы можете использовать разные комментарии. Мне любопытно, есть ли какие-то правила комментирования для этого или это как-то связано с автоматическим комментированием флаттера?
Мой выбор в пользу ///, так как цвет другой, поэтому лучше посмотреть, что я прокомментировал и что сделал флаттер.
Это заставляет меня задаться вопросом, почему есть два разных способа комментировать
// <-- This is a way
/// <-- This is a way
заранее спасибо





Согласно Эффективному дротику,
// для однострочного комментария, как внутри функции
/// для многострочных (хотя однострочные тоже поддерживаются) комментариев к документации, как у вас над определением функции.
Во 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
// -> Обозначает однострочный комментарий & /// -> Комментарий к документации. Чтобы узнать больше: dart.dev/guides/language/efficient-dart/documentation