COMPONENT DOCUMENTATION · SOURCE FIRST
Props 文件同步檢查
比對 React 元件的 Props 宣告、參數預設值與既有文件,查看變更及範例問題,再決定是否更新文件。
載入分析與文件
先以專案內的 component-docs scan 分析 TSX,完整命令見 README。本頁只讀
JSON,檔案各限 2 MB、500 個 Props、100 個範例、合計 10000
次範例欄位檢查;不執行元件、不上傳或自動儲存。報告可能包含預設值與程式片段。
請選擇報告;沒有既有文件時可檢視 Props 並下載初始文件。
Props 與文件差異
原始定義
使用範例檢查
建議文件保留既有人工描述與範例;範例問題不會自動修正。下載後請自行審查再套用。分析不完整時禁止產生建議文件,未解析到的舊 Props 只列為未確認。
支援範圍
首版支援直接具名匯出的 React function/arrow、同檔 interface/type literal 與解構參數。型別顯示宣告語法,未代替 TypeScript compiler。預設值只確認字串、數字、布林、null 等參數字面值;運算、匯入、wrapper 或繼承可能顯示未知/不完整。
範例只檢查必填、已宣告欄位、基本型別及字面值 union。函式、物件與引用型別等超出範圍者顯示未知;沒有問題不表示元件行為或完整型別檢查已通過。後續 defaultProps 賦值與執行期修改不在參數預設的分析範圍。