30 lines
1018 B
Plaintext
30 lines
1018 B
Plaintext
---
|
|
description: Documentation standards for Flutter/Dart code in prediqo_mobile
|
|
globs: prediqo_mobile/lib/**/*.dart
|
|
alwaysApply: false
|
|
---
|
|
|
|
# Prediqo mobile documentation conventions
|
|
|
|
Apply clear Dart doc comments (`///`) for maintainability, aligned with backend/prediqo_web standards.
|
|
|
|
## Required comments
|
|
|
|
1. **File** — Library-level `///` block at top describing layer (presentation, bloc, repository, model, core).
|
|
2. **Classes & widgets** — `///` summary; document public constructors when not obvious.
|
|
3. **Public methods & functions** — `///` with purpose; mention side effects (API calls, navigation, state).
|
|
4. **Models & events/states** — Brief `///` on each class/field group when mapping to API or domain concepts.
|
|
|
|
## Style
|
|
|
|
- English comments.
|
|
- Use `///` (not block `/** */`) for Dart doc style.
|
|
- Skip trivial getters/setters unless behavior is non-obvious.
|
|
|
|
## Example
|
|
|
|
```dart
|
|
/// Loads the authenticated user's profile and pre-fills the edit form.
|
|
Future<void> _loadProfile() async {
|
|
```
|