dangling_library_doc_comments

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

將函式庫文件註解 (使用 ///) 附加至函式庫指示詞，而不是將它們懸置在函式庫頂端附近。

不良範例

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

如果您改為使用 YAML map 語法來設定 linter 規則，請在 linter > rules 下新增 dangling_library_doc_comments: true

linter:
  rules:
    dangling_library_doc_comments: true

除非另有說明，否則本網站上的文件反映 Dart 3.7.1 版本。頁面最近更新於 2025-03-07。 檢視原始碼 或 回報問題。