dangling_library_doc_comments

將庫文件註釋附加到庫指令。

將庫文件註釋 (使用 ///) 附加到庫指令，而不是將其懸空在庫檔案的頂部附近。

不推薦 (BAD)

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

/// This is a great library.

class C {}

推薦 (GOOD)

/// 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 map 語法配置 linter 規則，請在 linter > rules 下新增 dangling_library_doc_comments: true

linter:
  rules:
    dangling_library_doc_comments: true