[Rust] 주석 달기

6 . 주석 달기

fn main() {
   // 문자열 출력
   println!("Hello World!");
}

main 함수에  ‘// 문자열 출력’ 부분이 추가 되었습니다.

실행 해 보면 이 부분은 아무런 영향도 미치지 않습니다. 

Rust의 주석은 “//“으로 시작합니다.

 

도큐먼테이션은 “///“로 시작합니다. 이 기능을 사용 하면 함수나 구조체, 모듈 등의 도큐먼트를 제작할 수 있습니다.

/// 출력 하는 함수 입니다
fn do_it(){
   println!("{}", "hello"); 
   }

VS Code나 intellij같은 IDE에서, do_it 함수 이름에 커서를 가져가면 do_it 함수에 대한 설명(“출력 하는 함수 입니다“)이 표시됩니다.

이런 기능은 다른 언어들에도 있기 때문에 특별한 것은 아닙니다.

Rust의 도큐먼테이션에는 그보다 더 대단한 기능이 있습니다.

우리가 만든 라이브러리에 대한 웹페이지를 자동으로 만들어 줍니다. 그것도 일관성있고 예쁘게 만들어 줍니다. 

Rust의 도큐먼테이션을 rustdoc이라고 합니다.

자세한 설명은 다음 링크를 참고 하십시오.

The rustdoc book

 

 

 

 

 

Rust를 공부하면서 눈에 보이는 Rust의 모습 중에 멋지다고 생각한 것이 두 가지가 있습니다.

Rust의 에러 메시지와 rustdoc입니다.

Rust의 에러 메시지는 굉장히 친절합니다.  Rust를 사용해 보면 금방 깨닫게 됩니다.

rustdoc은 라이브러리의 도큐먼트를 웹에 올리기 위한 수고를 덜어 줍니다.