Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[linter] enforce documenting libraries #59851

Open
lishaduck opened this issue Jan 7, 2025 · 0 comments
Open

[linter] enforce documenting libraries #59851

lishaduck opened this issue Jan 7, 2025 · 0 comments
Labels
area-analyzer Use area-analyzer for Dart analyzer issues, including the analysis server and code completion.

Comments

@lishaduck
Copy link

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

import 'package:something/something.dart';

Good Examples

/// Do awesomeness.
library;

import 'package:something/something.dart';

Considerations

  1. Gets verbose quickly.
  2. Can encourage quantity over quality.
@lishaduck lishaduck added the area-analyzer Use area-analyzer for Dart analyzer issues, including the analysis server and code completion. label Jan 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-analyzer Use area-analyzer for Dart analyzer issues, including the analysis server and code completion.
Projects
None yet
Development

No branches or pull requests

1 participant