dangling_library_doc_comments
Attach library doc comments to library directives.
Details
#Attach library doc comments (with ///
) to library directives, rather than
leaving them dangling near the top of a library.
BAD:
dart
/// This is a great library.
import 'package:math';
dart
/// This is a great library.
class C {}
GOOD:
dart
/// This is a great library.
library;
import 'package:math';
class C {}
NOTE: An unnamed library, like library;
above, is only supported in Dart
2.19 and later. Code which might run in earlier versions of Dart will need to
provide a name in the library
directive.
Enable
#To enable the dangling_library_doc_comments
rule,
add dangling_library_doc_comments
under linter > rules in your
analysis_options.yaml
file:
analysis_options.yaml
yaml
linter:
rules:
- dangling_library_doc_comments
If you're instead using the YAML map syntax to configure linter rules,
add dangling_library_doc_comments: true
under linter > rules:
analysis_options.yaml
yaml
linter:
rules:
dangling_library_doc_comments: true