1
주석
공개 아이템에 설명을 붙입니다
`///`와 `//!`로 사용법, 예제, Panics, Errors, Safety 같은 정보를 공개 API 가까이에 둡니다.
/// # Examples
CRATE RELEASE FLOW
문서와 공개 API를 먼저 정리하고 배포한다
crates.io에 올리기 전에는 코드가 컴파일되는지만 보지 않습니다. 공개 API의 경로, rustdoc 결과, 문서 예제 테스트까지 이어서 확인해야 사용자가 문서를 따라 바로 사용할 수 있습니다.
2
rustdoc
문서 화면에서 발견성을 봅니다
생성된 HTML에서 사용자가 처음 찾을 타입과 함수가 잘 드러나는지 확인합니다.
cargo doc
3
doc-test
예제가 실제 코드처럼 통과해야 합니다
문서 속 예시가 오래된 사용법으로 남지 않도록 테스트 결과를 함께 확인합니다.
cargo test
4
pub use
내부 구조와 공개 경로를 분리합니다
깊은 모듈에 있는 핵심 타입과 함수를 크레이트 루트로 다시 내보냅니다.
pub use self::utils::mix;
5
확인
배포 전에 영구 공개 항목을 점검합니다
이름, 설명, 라이선스, 버전, 토큰, 공개 API 경로를 마지막으로 살펴봅니다.
publish --dry-run
publish 직전 체크
1
문서 첫 화면에서 사용자가 핵심 API를 바로 찾을 수 있습니다.
2
문서 예제는 `cargo test`의 doc-test 단계에서 통과합니다.
3
Cargo.toml의 설명과 라이선스는 검색 결과에 보여도
자연스럽습니다.