目录

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