目次

未接続のライブラリドキュメントコメント

ライブラリディレクティブにライブラリドキュメントコメントを添付します。

このルールはDart 2.19以降で使用できます。

ルールセット:corerecommendedflutter

このルールにはクイックフィックスが用意されています。

詳細

#

ライブラリの先頭にコメントを放置するのではなく、ライブラリディレクティブにライブラリドキュメントコメント(///付き)を添付します。

悪い例

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

class C {}

良い例

dart
/// 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を追加します。

analysis_options.yaml
yaml
linter:
  rules:
    - dangling_library_doc_comments