跳到主要内容

missing_code_block_language_in_doc_comment

稳定版

代码块缺少指定的语言。

详情

#

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

为了启用 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

如果您改为使用 YAML 映射语法来配置 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