exploring-rust-crates
Generuj dokumentację Rust, aby zrozumieć API, strukturę i organizację crateów w swoim projekcie.
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Umiejętność do automatycznego generowania dokumentacji Rust dla crateów w workspace HASH. Pozwala szybko zrozumieć hierarchię modułów, publiczne API, dostępne funkcje, typy i traity bez ręcznego przeglądania kodu źródłowego. Generuje dokumentację z przykładami użycia i opisami błędów, ułatwiając eksplorację nieznanych pakietów Rust.
Jak używać
Otwórz terminal w katalogu workspace HASH i upewnij się, że masz zainstalowany Rust oraz cargo.
Uruchom polecenie generujące dokumentację dla konkretnego cratea, zastępując
rzeczywistą nazwą: cargo doc --no-deps --all-features --package . Flaga --no-deps dokumentuje tylko lokalny kod (szybciej), --all-features uwzględnia wszystkie warianty API, a --package wskazuje konkretny crate. Jeśli chcesz wygenerować dokumentację dla całego workspace, użyj: cargo doc --no-deps --all-features --workspace.
Poczekaj na zakończenie procesu generowania. Dokumentacja zostanie zapisana w katalogu target/doc/
/index.html. Otwórz wygenerowany plik index.html w przeglądarce, aby przeglądać hierarchię modułów, publiczne funkcje, typy, traity, przykłady użycia i dokumentację błędów.
Jeśli potrzebujesz zobaczyć także prywatne elementy implementacji, dodaj flagę --document-private-items do polecenia cargo doc.