exploring-rust-crates

此技能通過使用 cargo doc 提供自動化文檔生成，協助開發人員深入了解 HASH 的 Rust 代碼庫。它專為需要快速掌握新 crate 架構、識別公共 API 接口或理解複雜類型層次的工程師而設計。透過此工具，您可以生成詳細的 HTML 文檔，勾勒工作區內的模組邊界與依賴關係，從而深入理解各組件間的交互方式。

• 自動執行帶有 --no-deps 與 --all-features 等優化參數的 cargo doc，實現高效且相關的文檔生成。

• 提供明確的本地文檔訪問路徑（位於 target/doc/index.html）。

• 突出顯示關鍵的 API 表面，包括公共函數、Trait、常量與類型別名。

• 支持研究 Trait 實現、關聯類型與模組層次結構。

• 透過交叉參考記錄的錯誤條件，協助研究錯誤處理模式。

• 當您遇到陌生的 Rust 套件或需要理解 HASH 工作區的結構組織時，請使用此技能。

• 在開始深度重構任務前，請務必生成文檔，以確保清楚掌握內部實現細節，亦可選擇使用 --document-private-items。

• 參考 doctest 區塊中的代碼範例，學習 HASH 特定 crate 的慣用寫法。

• 請注意，文檔生成是針對工作區設計的；您可以使用 --package 指定特定 crate，或一次性生成整個工作區的文檔。

• 請注意生成的檔案會放置在 target 目錄中；若未使用 --no-deps，請確保在大規模依賴圖中擁有足夠的磁碟空間。

• 此工具專為 HASH 內的 Rust 開發工作流量身打造，並假設開發環境已正確配置 cargo 與 Rust 工具鏈。