missing_code_block_language_in_doc_comment 규칙 — doc 주석 코드 블록에 언어 지정하기
missing_code_block_language_in_doc_comment 규칙 — doc 주석 코드 블록에 언어 지정하기
문서 주석에 넣은 마크다운 코드 블록이 언어를 지정하지 않으면 구문 강조가 제대로 동작하지 않아요. 이 린트 규칙은 doc 주석의 코드 블록에 언어를 명시하도록 도와줘요.
본문
코드 블록에 언어가 지정되지 않았어요.
doc 주석의 코드 블록에는 사용하는 언어를 명시하세요.
마크다운 코드 블록의 구문 강조가 제대로 되려면, dart doc은 코드 블록을 여는 fence 뒤에 사용 언어를 지정하길 강력히 권장해요. dart doc이 지원하는 언어 목록은 highlight.js에서 확인할 수 있어요. 구문 강조를 끄거나 마땅한 언어가 없다면, 언어로 none을 지정하면 돼요.
좋지 않은 예:
/// ```
/// void main() {}
/// ```
class A {}
좋은 예:
/// ```dart
/// void main() {}
/// ```
class A {}
활성화하기
missing_code_block_language_in_doc_comment 규칙을 활성화하려면 analysis_options.yaml 파일의 linter > rules 아래에 missing_code_block_language_in_doc_comment를 추가하면 돼요:
linter:
rules:
- missing_code_block_language_in_doc_comment
린트 규칙을 YAML 맵 문법으로 설정하고 있다면, linter > rules 아래에 missing_code_block_language_in_doc_comment: true를 추가하면 돼요:
linter:
rules:
missing_code_block_language_in_doc_comment: true