跳到主要内容

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 {}