[ Rust ] 초급 문법 : 0. 주석 처리

 

러스트

 

 

초급 문법 : 0. 주석 처리

 

 

1. 러스트에서 주석이란?

주석(Comment)이란, 코드에 대한 설명을 적는 부분입니다.
이 부분은 프로그램 실행에 영향을 주지 않으며, 사람이 코드 내용을 쉽게 이해할 수 있도록 도와줍니다.

 

---

2. 주석을 작성하는 방법

① 한 줄 주석 (//)

한 줄짜리 주석을 작성할 때는 //를 사용합니다.
// 뒤에 오는 내용은 프로그램이 무시하고 실행되지 않습니다.

예제 코드 (한 줄 주석)

fn main() {
    // 이 코드는 화면에 "Hello, Rust!"를 출력합니다.
    println!("Hello, Rust!");
}

설명

• // 이후의 문장은 주석이므로 프로그램 실행에 영향을 주지 않습니다.
• println!("Hello, Rust!"); 는 실제로 실행되는 코드입니다.

---

② 여러 줄 주석 (/ /)

주석이 길어질 경우, 여러 줄을 한 번에 주석 처리할 수도 있습니다.
이때는 /* 와 */ 사이에 주석을 작성합니다.

예제 코드 (여러 줄 주석)

fn main() {
    /*
       이 프로그램은 콘솔에 "Hello, Rust!"를 출력하는 프로그램입니다.
       여러 줄의 설명을 주석으로 작성할 때 사용합니다.
    */
    println!("Hello, Rust!");
}

설명

• /* 와 */ 사이에 있는 모든 문장은 주석 처리됩니다.
• 코드에 대한 긴 설명이 필요할 때 사용하면 좋습니다.

---

③ 문서 주석 (///, //!, /** */)

일반적인 주석과는 다르게, 자동 문서화에 사용되는 주석이 있습니다.
이것은 나중에 cargo doc 같은 도구를 사용하여 코드 문서를 만들 때 유용합니다.

(1) /// : 함수, 구조체 등의 문서를 작성하는 주석

/// 이 함수는 "Hello, Rust!"를 출력합니다.
fn main() {
    println!("Hello, Rust!");
}

(2) //! : 파일 또는 모듈 전체에 대한 문서 주석

//! 이 파일은 러스트 주석 예제를 보여줍니다.

fn main() {
    println!("Hello, Rust!");
}

(3) /** */ : 여러 줄 문서 주석

/**
 * 이 함수는 콘솔에 "Hello, Rust!"를 출력합니다.
 * 여러 줄 설명이 가능합니다.
 */
fn main() {
    println!("Hello, Rust!");
}

---

3. VS Code에서 직접 실습하기

이제 직접 실습을 해보겠습니다!

① VS Code 실행하기

 

1️⃣ 터미널 열기

• VS Code를 실행하고, Ctrl + ~ (물결표) 키를 눌러 터미널을 엽니다.
• 또는 메뉴에서 [터미널] → [새 터미널] 선택하세요.

2️⃣ 새 Rust 프로젝트 생성

• 새로운 Rust 프로젝트를 만들 폴더로 이동 (예: C:\RustProjects)

cd C:\RustProjects

 

• 터미널에 아래 명령을 입력하고 Enter 키를 누릅니다.
• comment_demo라는 폴더가 생성됩니다.

cargo new comment_demo

 

 

3️⃣ 프로젝트 열기

• VS Code에서 [파일] → [폴더 열기] 선택 후 comment_demo 폴더를 엽니다.

4️⃣ 메인 파일 열기

• 왼쪽 src 폴더에서 main.rs 파일을 클릭하여 엽니다.

 

---

② 코드 작성하기

1. src/main.rs 파일을 열고 아래 코드를 입력하세요. 그리고 Ctrl + S를 눌러 파일을 저장합니다. (또는 메뉴 -> 파일 -> 저장)

fn main() {
    // 이 코드는 콘솔에 "Hello, Rust!"를 출력합니다.
    println!("Hello, Rust!");

    /*
       여러 줄 주석 예제입니다.
       이 부분은 실행되지 않습니다.
    */

    /// 이 함수는 프로그램의 시작점입니다.
    println!("This is a Rust comment example!");
}

---

③ 코드 실행하기

1. VS Code에서 터미널을 엽니다. (Ctrl + ~ 또는 보기(View) -> 터미널(Terminal))

2. 다음 명령어를 입력하여 프로그램을 실행합니다.

 

cargo run

 

3. 출력 결과를 확인하세요!

 

Hello, Rust! 
This is a Rust comment example!

 

 

---

4. 정리

주석	종류	사용법 예제
한 줄 주석	//	// 한 줄 주석입니다.
여러 줄 주석	/* */	/* 여러 줄 주석입니다. */
문서 주석 (함수 설명)	///	/// 이 함수는 "Hello"를 출력합니다.
문서 주석 (파일 설명)	//!	//! 이 파일은 Rust 주석 예제입니다.
여러 줄 문서 주석	/** */	/** 여러 줄 문서 주석입니다. */

 

 

 

이상으로 주석에 대해 알아보았습니다.

 

 

---

 

러스트 프로그래밍 언어 관련 글 목록입니다.

[ Rust ] 러스트 프로그래밍 언어 관련 글 목록입니다.

 

 

---

 

https://rust-kr.org/

한국 러스트 사용자 그룹

 

https://www.rust-lang.org/

Rust Programming Language