안드로이드스튜디오 Tip - 주석으로 코드 검사 개선

https://developer.android.com/studio/write/annotations?hl=ko

프로젝트에 주석 추가하기

프로젝트에서 주석을 사용하려면 라이브러리나 앱에 androidx.annotation:annotation 종속 항목을 추가합니다. 그러면 추가하는 주석에 대해 코드 검사 또는 lint 작업을 실행할 때 검사가 이루어집니다.

Jetpack Annotations 라이브러리 종속 항목 추가

Jetpack Annotations 라이브러리는 Google의 Maven 저장소에 게시됩니다. 프로젝트에 Jetpack Annotations 라이브러리를 추가하려면 build.gradle 또는 build.gradle.kts 파일의 dependencies 블록에 다음 줄을 포함합니다.

KotlinGroovy

 

dependencies {
    implementation("androidx.annotation:annotation:1.7.1")
}

툴바나 화면에 나타나는 동기화 알림 메시지에서 Sync Now를 클릭합니다.

자체 라이브러리 모듈에서 주석을 사용하는 경우에는 주석이 XML 형식으로 된 Android 보관 파일(AAR) 아티팩트의 일부로 annotations.zip 파일에 포함됩니다. androidx.annotation 종속 항목을 추가하더라도 라이브러리의 다운스트림 사용자에 대해서는 종속 항목이 적용되지 않습니다.

 

참고: 다른 Jetpack 라이브러리를 사용하는 경우 androidx.annotation 종속 항목을 추가할 필요가 없을 수도 있습니다. 다른 많은 Jetpack 라이브러리는 Jetpack Annotations 라이브러리에 종속되므로, 이미 주석에 액세스할 수 있습니다.

Jetpack 저장소에 포함된 주석의 전체 목록은 Jetpack Annotations 라이브러리 참조에서 확인하거나 자동 완성 기능을 사용하여 import androidx.annotation. 명령문에 사용 가능한 옵션을 표시하면 됩니다.

 

코드 검사 실행하기

Android 스튜디오에서 주석 유효성 검사와 자동 린트 검사가 있는 코드 검사를 시작하려면 메뉴에서 Analyze > Inspect Code를 선택합니다. Android 스튜디오에서는 충돌 메시지를 표시하여 개발자의 코드가 주석과 충돌할 가능성이 있는 문제를 신고하고 가능한 해결 방법을 제안합니다.

명령줄을 사용해 lint 작업을 실행함으로써 주석을 강제 적용할 수도 있습니다. 이 방법은 지속적 통합 서버 관련 문제를 신고하는 데 유용할 수도 있지만, lint 작업은 nullness 주석을 강제 적용하지 않습니다(다음 섹션에서 설명). Android 스튜디오만 강제 적용합니다. 린트 검사의 사용 설정과 실행에 관한 자세한 내용은 린트 검사로 코드 개선을 참고하세요.

주석 충돌로 인해 경고가 생성되더라도 앱 컴파일은 가능합니다.