ドキュメントコメント内のコードブロックに言語指定がありません
コードブロックに言語指定がありません。
このルールは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 > rulesにmissing_code_block_language_in_doc_comment
を追加します。
analysis_options.yaml
yaml
linter:
rules:
- missing_code_block_language_in_doc_comment
特に明記されていない限り、このサイトのドキュメントはDart 3.5.3を反映しています。ページの最終更新日:2024年7月3日。 ソースを表示 または 問題を報告する。