주석이나 애노테이션이 없는 library 지시문은 피해야 합니다

주석이나 애노테이션이 없는 library 지시문은 피해야 합니다

Dart 분석기가 만들어내는 'unnecessary_library_directive' 진단에 대한 자세한 내용입니다.

출처: unnecessary_library_directive

본문

Description

분석기는 library 지시문에 문서 주석(doc comment)이나 애노테이션이 없을 때 이 진단을 만들어냅니다. library 지시문 앞에 문서 주석이나 애노테이션이 없다면, 그 지시문은 불필요하거나(제거해도 되거나) 문서 주석이나 애노테이션이 잘못된 위치에 놓여 있어 옮겨야 한다는 뜻입니다.

Examples

다음 코드는 library 지시문에 문서 주석이나 애노테이션이 없기 때문에 이 진단을 만들어냅니다.

library;

class C {}

다음 코드는 라이브러리의 문서 주석이 library 지시문 아래에 있기 때문에 이 진단을 만들어냅니다.

library;

/// This library provides the [C] class.

/// The [C] class.
class C {}

Common fixes

라이브러리에 문서 주석이나 애노테이션을 추가하지 않으려면 library 지시문을 제거해주세요.

class C {}

문서 주석이나 애노테이션을 추가하려면, library 지시문에 추가하거나 그 앞으로 옮겨주세요.

/// This library provides the [C] class.
library;

/// The [C] class.
class C {}

더 알아보기