記錄一個函式做什麼
把一個沒文件的函式轉成清晰描述和 docstring —— 讓下一個人(或半年後的你)不必再逆向它。
沒文件的函式是會複利累積的技術債:每個讀者都要重複付出弄懂同一件事的成本。事後補寫 docstring 很枯燥,所以很少有人做。
這個工具讀懂函式,產出清晰解釋以及可直接貼上的 docstring,描述其用途、引數、返回值和副作用。你審一遍並提交,幾乎不費力就把黑盒變成有文件的程式碼。
對應工具
🧩遺留程式碼解讀
貼上看不懂的程式碼,得到逐段講解、資料流和風險點。
常見問題
會按我語言的風格寫 docstring 嗎? +
會。它會按你貼上語言的常見約定(JSDoc、Python docstring、Javadoc 等)生成。
會記錄引數和返回值嗎? +
會 —— 用途、引數、返回值和值得注意的副作用,讓文件真正有用。
提交前要審查嗎? +
務必。它起草準確的文件,但你應確認它符合預期行為。