メインコンテンツにスキップ

dangling_library_doc_comments

ぶら下がりライブラリドキュメントコメント。

説明

#

この診断は、ライブラリドキュメントのように見えるドキュメントコメントの後にlibraryディレクティブが続かない場合にアナライザーによって生成されます。具体的には、ライブラリ内の最初のディレクティブの前にドキュメントコメントが出現し、それがlibraryディレクティブではないと仮定される場合、または最初のトップレベル宣言の前にあり、宣言から1つ以上の空行で区切られている場合に生成されます。

#

以下のコードは、最初のimportディレクティブの前にドキュメントコメントがあるため、この診断を生成します。

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

以下のコードは、最初のクラス宣言の前にドキュメントコメントがありますが、コメントと宣言の間に空行があるため、この診断を生成します。

dart
/// This is a great library.

class C {}

一般的な修正

#

コメントがライブラリドキュメントの場合は、名前なしのlibraryディレクティブを追加します。

dart
/// This is a great library.
library;

import 'dart:core';

コメントが次の宣言のドキュメントである場合は、空行を削除します。

dart
/// This is a great library.
class C {}