内容

文档注释中代码块缺少语言

代码块缺少指定的语言。

此规则自 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