주석

모든 프로그램에는 주석이 필요합니다. 러스트는 여러 종류 주석을 지원합니다.

  • 일반 주석은 소스 코드를 읽는 사람을 위한 내용입니다. 컴파일러는 일반 주석의 내용을 무시합니다.
    • // 한 줄을 주석 처리합니다.
    • /* 닫는 기호 전까지의 내용을 블록 주석 처리합니다 */
  • 문서화 주석문서(Docmumentation)라는 HTML 문서로 변환됩니다.
    • /// 이 주석에 따라붙는 요소를 문서화합니다.
    • //! 이 주석을 포함하는 요소를 문서화합니다.
fn main() {
    // 한 줄 주석 예시입니다.
    // 각 줄은 슬래시 두 개로 시작합니다.
    // 컴파일러는 여기에 적힌 내용을 처리하지 않습니다.

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

    // 이 코드를 실행해보세요. Hello, world!가 출력되나요? 아무것도 출력되지 않는다면, 윗 줄의 슬래시 두 개를 지우고 다시 실행해보세요!

    /* 
     * 이건 블록 주석입니다.
     * 일반적으로 주석을 작성할 땐 한 줄 주석을 권장하지만,
     * 블록 주석은 여러 줄의 코드를 임시로 무효화할때 굉장히 유용합니다.
     * /* 블록 주석은 /* 중첩 가능합니다. */ */
     * 현재 main() 함수 내 모든 코드를 주석 처리하는 것도 키보드를 단 몇 번만 타이핑하면 됩니다.
     * /*/*/* 직접 해보세요! */*/*/
     */

    /*
    Note: 윗 문단의 `*`는 양식을 맞추기 위해 넣은 기호입니다.
    실제로는 없어도 됩니다.
    */

    // 표현식을 다룰 때 블록 주석을 응용할 수도 있습니다.
    // 다음 구문에서 주석 기호를
    // 제거해보세요.
    let x = 5 + /* 90 + */ 5;
    println!("`x`는 10일까요, 100일까요? x = {}", x);
}

See also:

라이브러리 문서화