`dangling_library_doc_comments` — 라이브러리 문서 주석이 달랑 떨어져 있어요
dangling_library_doc_comments — 라이브러리 문서 주석이 달랑 떨어져 있어요
라이브러리 문서처럼 보이는 문서 주석이 library 지시어 뒤에 붙지 않으면 이 진단이 발생해요. 주석이 어느 코드를 설명하는지가 애매할 때 뜬다고 생각하면 돼요. lint 규칙이에요.
본문
라이브러리 문서로 보이는 문서 주석이 library 지시어로 이어지지 않을 때 이 진단이 발생해요. 구체적으로는 두 경우예요. 문서 주석이 라이브러리의 첫 지시어 앞에 있는데 그 지시어가 library 지시어가 아니거나, 첫 번째 최상위 선언 앞에 있으면서 그 선언과 한 줄 이상의 빈 줄로 떨어져 있는 경우예요.
예시
아래 코드는 첫 번째 import 지시어 앞에 문서 주석이 있어서 이 진단이 발생해요.
/// This is a great library.
import 'dart:core';
아래 코드는 첫 번째 클래스 선언 앞에 문서 주석이 있는데, 주석과 선언 사이에 빈 줄이 있어서 이 진단이 발생해요.
/// This is a great library.
class C {}
흔한 해결 방법
주석이 라이브러리 문서라면, 이름이 없는 library 지시어를 추가해 주면 돼요.
/// This is a great library.
library;
import 'dart:core';
주석이 바로 뒤에 오는 선언을 설명하는 문서라면, 빈 줄을 제거해 주면 돼요.
/// This is a great library.
class C {}