Skip to content

3.4. Comments

모든 프로그래머는 코드를 이해하기 쉽게 만들기 위해 노력하지만 때로는 추가적인 설명이 필요할 때가 있습니다. 이러한 경우 프로그래머는 소스 코드에 컴파일러는 무시하지만 소스 코드를 읽는 사람들이 유용하다고 생각할 수 있는 주석을 남깁니다.

다음은 간단한 주석입니다:

// hello, world

Rust에서 관용적 주석 스타일은 슬래시 두 개로 주석을 시작하며 주석은 줄이 끝날 때까지 계속됩니다. 한 줄을 넘어서는 주석의 경우 다음과 같이 각 줄에 //를 포함해야 합니다:

// So we're doing something complicated here, long enough that we need
// multiple lines of comments to do it! Whew! Hopefully, this comment will
// explain what's going on.

주석은 코드가 포함된 줄의 끝에 배치할 수도 있습니다:

src/main.rs
fn main() {
    let lucky_number = 7; // I'm feeling lucky today
}

하지만 주석이 달린 코드 위에 별도의 줄에 주석을 달아 이 형식으로 사용하는 경우가 더 많습니다:

src/main.rs
fn main() {
    // I'm feeling lucky today
    let lucky_number = 7;
}

Rust에는 또 다른 종류의 주석인 문서 주석도 있는데, 이는 14장의 "Crates.io에 크레이트 게시하기" 섹션에서 설명합니다.

References