주석

안내

C, C++, Java, C#를 배운 적이 있다면 이번 수업을 건너뛰어도 괜찮습니다. Rust의 주석 문법이 이 언어들과 거의 동일하기 때문입니다.

주석이란 무엇인가요?

사람이 읽기 위한 설명 텍스트로, 컴파일러가 무시하고 프로그램 실행에 반영되지 않습니다.

주석의 역할은 무엇일까요?

• 코드 기능 설명 : 다른 개발자가 코드를 쉽게 이해할 수 있도록 작성
• 작성 정보 기록 : 자동 문서 생성 툴에서 활용
• 임시 코드 비활성화 : 코드를 삭제하지 않고 실행만 막고 싶을 때 주석으로 처리
• 코드 가독성 향상

Rust의 주석 2~3가지 작성 방식

• 한 줄 주석 : //로 시작해서 해당 줄 끝까지 주석 처리
• 블록 주석 : 여러 줄의 코드를 한 번에 감쌀 수 있으며 줄을 넘겨 사용 가능 /* ... */

주석은 마치 교과서에 적는 필기 메모와 같아서 코드 내용을 파악하기 쉽게 만들어줍니다.

먼저 자주 사용하는 두 가지 주석을 배우고 이후 세 번째 방식을 다루겠습니다.

fn main() {
    // 한 줄 주석은 슬래시 두 개로 시작하며 줄 끝까지 적용됨
    // // 뒤에 적은 모든 내용은 컴파일러가 무시한다.

    // 예시: 아래 코드는 실행되지 않음
    // println!("Hello, world!");

    // 위쪽의 //을 지우고 코드를 다시 실행해보자.

    /*
     * 블록 주석은 코드를 임시로 비활성화할 때 유용하다. 아래 예시 참고
     * 중첩도 지원: /* 이런 식 */, 긴 코드 블록을 한 번에 주석 처리 가능
     */

    /*
     * println!("Hello, world!");
     * println!("Hello, world2!");
     */

    /*
    참고: 왼쪽 별표(*)는 보기 좋게 정렬하기 위한 것일 뿐,
    문법상 필수 요소가 아니므로 생략해도 무방하다.
    */

    // 블록 주석 시작 부분에 슬래시 하나만 추가해도 코드 활성/비활성 전환이 간편하다:

    /* <- 여기에 슬래시를 하나 더 붙이면 아래 전체 블록 주석이 해제된다 (/* 앞에 /를 붙여 //*로 만들어 직접 테스트해보자)

    println!("지금");
    println!("모든");
    println!("코드가 실행됨!");
    // 내부 한 줄 주석은 영향 받지 않음

    // */

    // 블록 주석은 표현식 중간에 삽입하는 것도 가능하다:
    let x = 5 + /* 90 + */ 5;
    println!("`x`는 10일까 100일까? x = {}", x);
}Code language: PHP (php)

위 코드를 복사해서 직접 실행해보세요. 특히 「/* <- 여기에 슬래시를 하나 더 붙이면 아래 전체 블록 주석이 해제된다」 부분을 테스트해보시기 바랍니다.

(설명: /* 앞에 /를 붙여 //*로 만들면 블록 주석 시작 기호가 무효화되고, 뒤쪽의 // */ 또한 한 줄 주석으로 인식되는 원리입니다.)

이렇게 하면 임시로 블록 주석이 해제되어 안쪽의 println 코드가 실행됩니다.

문서 주석

문서 주석은 전용 도구를 통해 HTML 형식의 문서를 자동 생성할 수 있어 개발자가 참고하기 편리합니다. 이 내용은 다음 수업에서 별도로 자세히 다루겠습니다.