dangling_library_doc_comments

ライブラリのドキュメントコメントをライブラリディレクティブにアタッチします。

ライブラリの先頭付近にコメントをぶら下げておくのではなく、ライブラリのドキュメントコメント（/// を使用）をライブラリディレクティブにアタッチします。

悪い例

/// This is a great library.
import 'package:math';

/// This is a great library.

class C {}

良い例

/// This is a great library.
library;

import 'package:math';

class C {}

注意: 名前が指定されていないライブラリ（例: 上記の library;）は、Dart 2.19 以降でしかサポートされません。Dart の以前のバージョンで実行される可能性のあるコードでは、library ディレクティブに名前を指定する必要があります。

dangling_library_doc_comments ルールを有効にするには、analysis_options.yaml ファイルの linter > rules の下に dangling_library_doc_comments を追加します。

linter:
  rules:
    - dangling_library_doc_comments

代わりに YAML マップ構文を使用してリンタルールを設定している場合は、linter > rules の下に dangling_library_doc_comments: true を追加します。

linter:
  rules:
    dangling_library_doc_comments: true