跳到主要內容

dangling_library_doc_comments

懸空庫文件註釋。

描述

#

當一個看似庫文件的文件註釋後面沒有跟著 library 指令時,分析器會產生此診斷。更具體地說,當文件註釋出現在庫中的第一個指令之前(假設它不是 library 指令),或出現在第一個頂層宣告之前,並且與該宣告之間隔開了一行或多行空行時,就會產生此診斷。

示例

#

以下程式碼會產生此診斷,因為在第一個 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 {}