跳到主要内容

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

稳定

代码块缺少指定的语言。

详情

#

请务必指定文档注释中代码块使用的语言。

为了启用 Markdown 代码块的正确语法高亮,dart doc 强烈建议在初始代码围栏后指定代码块使用的语言。

请参阅 highlight.js 查看 dart doc 支持的语言列表。要禁用语法高亮或如果没有合适的语言,可以指定 none 作为语言。

不推荐

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

推荐

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

启用

#

要在 analysis_options.yaml 文件中启用 missing_code_block_language_in_doc_comment 规则,请在 linter > rules 下添加 missing_code_block_language_in_doc_comment

analysis_options.yaml
yaml
linter:
  rules:
    - missing_code_block_language_in_doc_comment

如果改用 YAML map 语法配置 linter 规则,请在 linter > rules 下添加 missing_code_block_language_in_doc_comment: true

analysis_options.yaml
yaml
linter:
  rules:
    missing_code_block_language_in_doc_comment: true