문서화
Rust comes with extensive documentation. For example:
- All of the details about loops.
u8과 같은 기본 타입- Standard library types like
OptionorBinaryHeap.
사실 자체 코드를 문서화할 수 있습니다.
콘텐츠는 마크다운으로 처리됩니다. 게시된 모든 Rust 라이브러리 크레이트는 rustdoc 도구를 사용하여 docs.rs에 자동으로 문서화됩니다. 일반적으로 API의 모든 공개 항목은 이 패턴을 사용하여 문서화됩니다.
항목 내부(예: 모듈 내부)의 항목을 문서화하려면 ’내부 문서 주석’이라고 하는 //! 혹은 /*! .. */를 사용하세요.
Speaker Notes
This slide should take about 5 minutes.
- Show students the generated docs for the
randcrate at https://docs.rs/rand.