[Rust] 주석

---

---

개요

모든 개발자는 자신의 코드를 이해하기 쉽게 작성하고 싶어한다. 그러나 코드만으로는 설명이 부족할 때가 있다. 이럴 때, 개발자는 주석을 코드에 추가할 수 있다. 컴파일러는 이 주석을 무시하지만, 코드를 읽는 사람에게는 도움이 될 수 있다.

다음은 주석의 간단한 예시이다:

// hello, world

Rust에서는 주석을 표시할 때 ‘//’를 사용한다. 이렇게 작성된 주석은 해당 줄의 끝까지 유효하다. 여러 줄에 걸친 주석을 작성하려면, 각 줄마다 ‘//’를 앞에 붙여야 한다.

// 여기서 복잡한 작업을 진행하므로
// 주석을 여러 줄에 걸쳐 작성한다.
// 이 주석을 통해 코드의 동작을 이해하는 데
// 도움이 되길 바란다.

주석은 코드가 포함된 줄의 끝부분에도 작성될 수 있다:

파일명: src/main.rs

fn main() {
let lucky_number = 7; // 오늘 행운이 따르길 바란다
}

그러나 대부분 주석은 코드 위의 별도 줄에 작성된다:

파일명: src/main.rs

fn main() {
// 오늘 행운이 따르길 바란다
let lucky_number = 7;
}

또한 Rust에는 문서 주석이라는 다른 형태의 주석도 있다. 이는 추후 “Crates.io에 크레이트 게시하기” 섹션에서 자세히 설명할 것이다.

---

출처: rust-lang book