[Rust] 문서화

Rust 코드를 문서화하는 것은 아주 간단하다.
현재 디렉토리 커맨드에서 cargo doc을 치면 된다.

그럼 target 폴더에 웹페이지 형식으로 된 문서를 알아서 생성해준다.

저기 프로젝트명 폴더 안을 까보면 index.html이 있다. 그걸 직접 열거나
cargo doc --open을 치면

익숙한 인터페이스가 뜬다.

근데 아무것도 없네?

지금 코드에 공개된 함수가 없어서 그렇다.

외부로 공개할 함수를 pub 해두고 cargo doc을 다시 수행하면

이렇게 뜬다.

뚜둔.

근데 저대로는 영 밋밋하다.
뭐 설명이라도 붙여야 하지 않겠는가?
함수 위에 슬래시 세개짜리 주석을 붙이면 그게 문서화가 된다.

뚜둔

참고로 저기 들어가는 텍스트는 마크다운 문법을 따른다.

그리고 첫번째 줄의 텍스트만 함수 소개문에 들어가고, 나머지는 해당 항목에 들어가야만 보인다.

구조체같은 것도 잘 된다. 뭐든 pub만 붙이면 다 문서화가 된다.