目次

ドキュメントコメント内コードブロック言語指定がありません

コードブロックに言語指定がありません。

このルールはDart 3.4以降で使用可能です。

詳細

#

必ずドキュメントコメントのコードブロックで使用されている言語を指定してください。

Markdownコードブロックの適切なシンタックスハイライトを有効にするために、dart docは、最初のコードフェンスの後に使用されている言語を指定することを強く推奨しています。

dart docでサポートされている言語のリストについては、highlight.jsを参照してください。シンタックスハイライトを無効にする場合、または適切な言語がない場合は、言語として`none`を指定できます。

悪い例

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

良い例

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

使用方法

#

missing_code_block_language_in_doc_commentルールを有効にするには、analysis_options.yamlファイルのlinter > rulesmissing_code_block_language_in_doc_commentを追加します。

analysis_options.yaml
yaml
linter:
  rules:
    - missing_code_block_language_in_doc_comment