AIKraft/AI/Войти
AIKraft/Skills/dart-write-documentation

dart-write-documentation

Устанавливает правила и форматирование для написания документации Dart /// API и doc comments. Применяется при документировании кода Dart, создании комментариев для библиотек, классов, методов и переменных, а также при следовании руководства Effective Dart.

flutter official Документы ★ 3k

Что делает навык

Устанавливает правила и форматирование для написания документации Dart /// API и doc comments. Применяется при документировании кода Dart, создании комментариев для библиотек, классов, методов и переменных, а также при следовании руководства Effective Dart.

Когда применять

  • Документирование публичных объявлений Dart (библиотек, классов, методов, переменных).
  • Создание кратких сводок в первом абзаце doc comments для извлечения Dartdoc.
  • Обновление существующей документации с соблюдением стандартов Effective Dart.
  • Форматирование комментариев в виде правильных предложений с заглавной буквы и точкой.

Как работает

  1. Определить, что документация относится к публичным членам (не начинающимся с подчеркивания _).
  2. Использовать только /// последовательные строковые комментарии, избегая /** ... */.
  3. Сформировать первый абзац как одно краткое предложение, суммирующее элемент, и завершить его точкой.
  4. Отделить первый абзац от остальной документации пустой строкой, содержащей ///.
  5. Оформить все комментарии как правильные предложения, начиная с заглавной буквы (если это не идентификатор) и заканчивая точкой.

Примеры запросов агенту

Напиши документацию для публичного метода класса Flutter, описывающего его назначение.
Обнови doc comments для библиотеки, следуя правилам Effective Dart.
Добавь комментарии к публичным переменным, используя формат /// и правильные предложения.

Описание составлено по SKILL.md навыка, сверено 07.10.2026.

Как подключить

1Скачать навык
# возьмите папку навыка «dart-write-documentation» из репозитория: # https://github.com/flutter/agent-plugins
2Положить папку с SKILL.md к навыкам ассистента
# положите папку навыка туда, где ассистент ищет skills: cp -r dart-write-documentation/ ~/.claude/skills/dart-write-documentation/

Навык — папка с файлом SKILL.md (описание + инструкции) и опциональными скриптами. Ассистент (Claude, Claude Code и совместимые) подхватывает его по описанию и следует шагам.