mirror of
https://github.com/smmarty/friflex_flutter_starter.git
synced 2026-02-05 03:32:18 +00:00
feat: добавлена новый skill flutter_dev и документация (#46)
This commit is contained in:
29
.agent/skills/flutter_dev/references/documentation.md
Normal file
29
.agent/skills/flutter_dev/references/documentation.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# Документирование кода
|
||||
|
||||
## Документация (///)
|
||||
- Оформляется с использованием `///` над объектом.
|
||||
- Обязательна для всех классов, конструкторов, полей, методов и фабрик.
|
||||
- Должна быть краткой, емкой и указывать на назначение.
|
||||
|
||||
### Шаблоны
|
||||
- **Классы**: Используйте `{@template name}` и `{@endtemplate}`.
|
||||
- **Конструкторы**: Если один — `{@macro name}`.
|
||||
- **Параметры**: Используйте ссылки в квадратных скобках `[paramName]`.
|
||||
|
||||
### Пример метода
|
||||
```dart
|
||||
/// Метод для расчета температуры.
|
||||
/// Принимает:
|
||||
/// - [grad] - параметр для расчета.
|
||||
/// Возвращает температуру в градусах. Null при ошибке.
|
||||
int? calcTemperature({required int grad}) { ... }
|
||||
```
|
||||
|
||||
## Комментарии (//)
|
||||
- Используются только там, где код не очевиден.
|
||||
- Не должны повторять то, что и так понятно из имен переменных или структуры.
|
||||
|
||||
## TODO
|
||||
- Формат определяется линтером.
|
||||
- Указывать имя разработчика в контексте.
|
||||
- Указывать ссылку на задачу в скобках, если она известна.
|
||||
Reference in New Issue
Block a user