feat: Update documentation guidelines for concise class and method comments
This commit is contained in:
@@ -54,7 +54,7 @@ If any of these files are missing or unreadable, notify the user before proceedi
|
|||||||
- Use `BlocProvider.value()` for singleton BLoCs
|
- Use `BlocProvider.value()` for singleton BLoCs
|
||||||
- Use `UiColors`, `UiTypography`, `UiIcons`, `UiConstants` for all design values
|
- Use `UiColors`, `UiTypography`, `UiIcons`, `UiConstants` for all design values
|
||||||
- Use `core_localization` for user-facing strings
|
- Use `core_localization` for user-facing strings
|
||||||
- Add human readable doc comments for `dartdoc` for all classes and methods.
|
- Add concise `///` doc comments to every class, method, and field. Keep them short (1-2 lines) — just enough for another developer to understand the purpose without reading the implementation.
|
||||||
|
|
||||||
## Standard Workflow
|
## Standard Workflow
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user