exploring-rust-crates

此技能為開發者提供一套系統化的方法，用於在 HASH 開發環境中產生、檢查與分析 Rust 軟體包 (crate) 的說明文件。透過利用 cargo doc，它能將原始程式碼轉化為可瀏覽的網頁介面，幫助工程師快速繪製模組層級圖，並理解複雜 Rust 套件的公開 API 介面。此工具專為加入 HASH monorepo 的開發者、進行內部套件重構的工程師，或是在處理需要深入理解 Trait Bounds 和關聯型別 (Associated Types) 的除錯場景時所設計。

• 使用 cargo doc 為特定套件或整個工作區產生完整的 HTML 說明文件。

• 呈現程式碼庫中所有公開 API 的詳細資訊，包含函式、型別、Trait 與常數。

• 支援透過 --all-features 納入功能標記 (feature-gated) 的 API，確保條件式程式碼的完整覆蓋。

• 提供模組組織、元件關係與內部依賴結構的清晰視圖。

• 透過文件中的 doctest 範例與錯誤處理模式，加速學習與開發效率。

• 執行說明文件指令時，可指定 --package 進行針對性分析，或使用 --workspace 進行全域分析。

• 建議使用 --no-deps 旗標，將輸出限制在本地原始碼範圍內，以縮短建置時間並減少雜訊。

• 產生的文件會儲存於 target/doc 目錄，index.html 是瀏覽器探索的主要入口點。

• 務必參考生成文件中的 # Examples 與 # Errors 章節，以掌握 HASH 內部的慣用 Rust 用法與錯誤傳遞模式。

• 請注意，產生文件屬於編譯階段，請在執行指令前確認您的本地 Rust 工具鏈與環境變數已依照儲存庫設定說明完成配置。