주석 사용하기
코드에 주석을 추가합니다
주석 사용하기은(는) CoddyKit의 무료 Kotlin Academy 강의입니다. 이것은 4개 중 1번째 강의입니다. 아래에서 전체 강의를 무료로 읽을 수 있으며, 내장 코드 에디터와 24/7 AI 튜터와 함께 브라우저에서 직접 실습할 수 있습니다. 이 강의는 Kotlin Academy 학습 경로의 일부이며, 진행 상황이 웹과 CoddyKit 앱에 동기화됩니다. Kotlin Academy 강의에는 총 4개의 강의가 포함되어 있습니다.
애너테이션이란 무엇인가
애너테이션은 코드에 메타데이터를 연결합니다. 애너테이션 자체로 동작을 변경하지는 않지만, 도구와 컴파일러, 라이브러리가 이를 읽고 판단을 내립니다.
@ 뒤에 이름을 붙여 애너테이션을 작성하고, 적용할 요소 바로 앞에 배치합니다.
첫 애너테이션
표준 라이브러리에는 유용한 애너테이션이 여러 가지 포함되어 있습니다. @Deprecated는 더 이상 사용하지 않아야 하는 코드를 표시하고 호출 위치에 경고를 표시합니다.
@Deprecated("Use newGreet() instead")
fun greet() = "Hi"
fun newGreet() = "Hello"
fun main() {
println(newGreet())
}인수가 있는 애너테이션
애너테이션은 생성자 매개변수처럼 작성하는 인수를 받을 수 있습니다. @Deprecated는 메시지와 선택적인 ReplaceWith 힌트를 받습니다.
@Deprecated(
message = "Renamed for clarity",
replaceWith = ReplaceWith("sum(a, b)")
)
fun add(a: Int, b: Int) = a + b
fun sum(a: Int, b: Int) = a + b
fun main() {
println(sum(2, 3))
}경고 억제하기
@Suppress는 애너테이션이 적용된 요소에 대해 특정 경고를 표시하지 않도록 컴파일러에 지시합니다. 경고 이름을 문자열로 전달합니다.
@Suppress("UNUSED_VARIABLE")
fun main() {
val unused = 42
println("Runs without the unused-variable warning")
}JvmStatic와 친구들
일부 주석은 Kotlin이 JVM용으로 컴파일되는 방식에 영향을 줍니다. @JvmStatic, @JvmField, @JvmName은 바이트코드를 제어하여 Java 호출자가 더 편리한 API를 사용할 수 있게 합니다.
순수한 Kotlin 코드에서는 아무 동작도 하지 않지만 상호 운용성에서는 중요합니다.
class Math {
companion object {
@JvmStatic
fun square(x: Int) = x * x
}
}
fun main() {
println(Math.square(5))
}주석 적용 위치 대상
속성은 여러 JVM 요소를 생성할 수 있습니다. 필드, 가져오기 함수, 설정 함수, 생성자 매개변수가 이에 해당합니다. 사용 위치 대상은 주석을 어느 곳에 적용할지 지정합니다.
구문: @get:, @set:, @field:, @param:.
class User(@get:JvmName("fetchName") val name: String)
fun main() {
val u = User("Ada")
println(u.name)
}Java 상호 운용성을 위한 Throws
Kotlin에는 검사 예외가 없으므로 @Throws를 추가하지 않으면 Java 호출자에게 throws 절이 표시되지 않습니다. 이 주석은 예외 유형을 바이트코드 서명에 기록합니다.
import java.io.IOException
@Throws(IOException::class)
fun readData(): String {
return "data"
}
fun main() {
println(readData())
}여러 주석
하나의 요소에 여러 주석을 차례로 적용할 수 있습니다. 각 주석은 별도의 줄에 작성하거나 공백으로 구분합니다. 순서는 중요하지 않습니다.
@Deprecated("old")
@Suppress("DEPRECATION")
fun legacy() = "still here"
fun main() {
println(legacy())
}식에 적용하는 주석
주석은 최상위 함수나 클래스뿐 아니라 식과 지역 선언에도 적용할 수 있습니다. 함수 본문 안에서 @Suppress를 사용하는 경우가 이에 해당합니다.
fun main() {
@Suppress("UNUSED_VARIABLE")
val temp = computeOnce()
println("Done")
}
fun computeOnce() = 99OptIn과 실험적 API
라이브러리는 사용자 지정 옵트인 주석으로 불안정한 API를 표시합니다. 이러한 API를 사용하려면 @OptIn(SomeApi::class)로 위험을 인지했음을 나타내거나 주석을 전달해야 합니다.
이렇게 하면 실험적 기능을 실수로 사용하는 대신 명시적으로 사용할 수 있습니다.
fun main() {
// @OptIn would appear here when calling an experimental function
println("Opt-in keeps unstable APIs visible")
}주석을 사용하는 이유
주석을 사용하면 도구에 의도를 전달할 수 있습니다. 컴파일러는 더 이상 사용되지 않는 호출에 경고를 표시하고, 직렬화 라이브러리는 필드를 매핑하며, 테스트 프레임워크는 테스트 메서드를 찾고, 의존성 주입 프레임워크는 의존성을 연결합니다.
- 논리가 아닌 메타데이터
- 컴파일 시점이나 실행 시점에 읽음
- 코드 가까이에 설정을 유지함
빠른 확인
주석 사용에 대한 이해도를 확인해 보세요.
복습
다음과 같은 기본 제공 주석을 사용하는 방법을 배웠습니다.
@Deprecated,@Suppress,@Throws- JVM 상호 운용성:
@JvmStatic,@JvmName @get:,@field:와 같은 사용 위치 대상- 실험적 API를 위한 옵트인
다음에는 직접 주석을 정의합니다.
자주 묻는 질문
“주석 사용하기” 강의는 무료인가요?
네 — “주석 사용하기” 전체 내용을 이 웹사이트에서 무료로 읽을 수 있습니다. 인터랙티브하게 실습하려면(내장 코드 에디터와 24/7 AI 튜터), CoddyKit PRO로 업그레이드하면 Kotlin Academy 강의 전체를 잠금 해제할 수 있습니다. Kotlin Academy 강의에는 총 4개의 강의가 포함되어 있습니다.
“주석 사용하기”에서 뭘 배우나요?
코드에 주석을 추가합니다 브라우저에서 직접 실행하는 실습 코드로 Kotlin Academy을(를) 배우며, 24/7 AI 튜터가 강의를 진행하면서 질문에 답변해줍니다.
Kotlin Academy을(를) 시작하는 데 경험이 필요한가요?
사전 경험은 필요하지 않습니다. CoddyKit의 Kotlin Academy은(는) 초급자부터 고급 학습자까지를 위해 구성되어 있으므로, 여기서 시작하거나 처음부터 시작할 수 있으며 자신의 속도대로 진행할 수 있습니다. 이것은 4개 중 1번째 강의입니다.
“주석 사용하기” 강의는 얼마나 걸리나요?
대부분의 CoddyKit 강의는 약 5~10분이 소요됩니다. 각 강의는 간결하고 인터랙티브하여 꾸준한 진행이 가능하며, 웹과 앱에서 중단한 부분부터 바로 시작할 수 있습니다.
이 Kotlin Academy 강의에서 코드를 작성하고 실행할 수 있나요?
네. 모든 Kotlin Academy 강의에는 내장 코드 에디터가 포함되어 있으므로, 브라우저에서 바로 실제 코드를 작성하고 실행한 후 즉시 AI 피드백을 받을 수 있습니다 — 로컬 설정이 필요 없습니다.