공개 멤버의 문서 주석이 빠진 경우

공개 멤버의 문서 주석이 빠진 경우 (public_member_api_docs)

패키지의 공개 API에 속하는 멤버는 문서 주석(documentation comment)이 필요해요. 이 lint는 그 주석이 빠졌을 때 알려줘요.

출처: public_member_api_docs

본문

Dart 분석기(analyzer)는 패키지 공개 API의 일부 선언에 문서 주석이 없을 때 이 진단을 내요.

예시

아래 코드는 C 클래스에 문서 주석이 없어서 이 진단이 발생해요.

class C {}

일반적인 해결 방법

문서 주석을 추가하면 돼요.

/// Documentation comment.
class C {}

더 알아보기