You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add library-level documentation comments to all libraries.
Details
When writing libraries, also add documentation to the library directive (including creating the library directive).
This encourages people to write documentation, which show up as handy hovers for imports in IDEs.
Kind
(This template doesn't seem to around post-sdk migration, so I don't know the options.)
Bad Examples
import'package:something/something.dart';
Good Examples
/// Do awesomeness.library;
import'package:something/something.dart';
Considerations
Gets verbose quickly.
Can encourage quantity over quality.
The text was updated successfully, but these errors were encountered:
lishaduck
added
the
area-analyzer
Use area-analyzer for Dart analyzer issues, including the analysis server and code completion.
label
Jan 7, 2025
Description
Add library-level documentation comments to all libraries.
Details
When writing libraries, also add documentation to the library directive (including creating the library directive).
This encourages people to write documentation, which show up as handy hovers for imports in IDEs.
Kind
(This template doesn't seem to around post-sdk migration, so I don't know the options.)
Bad Examples
Good Examples
Considerations
The text was updated successfully, but these errors were encountered: