跳到主要內容

缺少_文件_註釋_中_程式碼_塊_語言

穩定

程式碼塊缺少指定的語言。

詳情

#

請務必指定文件註釋中程式碼塊使用的語言。

為了啟用 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