모든 프로그래머는 코드를 이해하기 쉽게 만들려고 노력하지만, 때로는 추가적인 설명이 필요할 때가 있습니다. 이러한 경우, 프로그래머는 컴파일러가 무시하지만 소스 코드를 읽는 사람이 유용하다고 생각할 수 있는 *주석 (comments)*을 소스 코드에 남깁니다.
다음은 간단한 주석입니다.
// hello, world
Rust 에서 관용적인 주석 스타일은 두 개의 슬래시 //로 주석을 시작하며, 주석은 해당 줄의 끝까지 이어집니다. 여러 줄에 걸쳐 주석을 작성해야 하는 경우, 다음과 같이 각 줄에 //를 포함해야 합니다.
// 여기에서 복잡한 작업을 수행하고 있으며,
// 여러 줄의 주석이 필요할 정도로 깁니다! 휴!
// 이 주석이 무슨 일이 일어나고 있는지 설명해 주기를 바랍니다.
주석은 코드 줄의 끝에 배치할 수도 있습니다.
파일 이름: src/main.rs
fn main() {
let lucky_number = 7; // 오늘은 운이 좋은 날입니다.
}
하지만 주석이 주석을 다는 코드 위에 별도의 줄에 있는 이 형식을 더 자주 보게 될 것입니다.
파일 이름: src/main.rs
fn main() {
// 오늘은 운이 좋은 날입니다.
let lucky_number = 7;
}
Rust 에는 "Publishing a Crate to Crates.io"에서 논의할 다른 종류의 주석인 문서 주석도 있습니다.