dangling_library_doc_comments

將函式庫文件註解附加至函式庫指示詞。

此規則從 Dart 2.19 開始可用。

規則集：核心、建議、flutter

此規則有可用的快速修正。

將函式庫文件註解（使用 ///）附加至函式庫指示詞，而不是讓它們懸掛在函式庫的頂部附近。

錯誤

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

/// This is a great library.

class C {}

正確

/// 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

除非另有說明，否則本網站上的文件反映 Dart 3.6.0。頁面上次更新時間為 2024-07-03。 檢視原始碼 或 回報問題。