內容

missing_code_block_language_in_doc_comment

程式碼區塊缺少指定的語言。

此規則在 Dart 3.4 版本起提供。

詳細資訊

#

務必在文件註解的程式碼區塊中指定使用的語言。

為了啟用 Markdown 程式碼區塊的正確語法突顯功能,dart doc 強烈建議程式碼區塊在初始程式碼圍欄後指定使用的語言。

請參閱 highlight.js 以取得 dart doc 支援的語言清單。若要停用語法突顯功能,或沒有適合的語言,您可以指定 none 作為語言。

錯誤範例

dart
/// ```
/// void main() {}
/// ```
class A {}

正確範例

dart
/// ```dart
/// void main() {}
/// ```
class A {}

用法

#

若要啟用 missing_code_block_language_in_doc_comment 規則,請在 analysis_options.yaml 檔案的 linter > rules 下方加入 missing_code_block_language_in_doc_comment

analysis_options.yaml
yaml
linter:
  rules:
    - missing_code_block_language_in_doc_comment