记录一个函数做什么
把一个没文档的函数转成清晰描述和 docstring —— 让下一个人(或半年后的你)不必再逆向它。
没文档的函数是会复利累积的技术债:每个读者都要重复付出弄懂同一件事的成本。事后补写 docstring 很枯燥,所以很少有人做。
这个工具读懂函数,产出清晰解释以及可直接粘贴的 docstring,描述其用途、参数、返回值和副作用。你审一遍并提交,几乎不费力就把黑盒变成有文档的代码。
对应工具
🧩遗留代码解读
粘贴看不懂的代码,得到逐段讲解、数据流和风险点。
常见问题
会按我语言的风格写 docstring 吗? +
会。它会按你粘贴语言的常见约定(JSDoc、Python docstring、Javadoc 等)生成。
会记录参数和返回值吗? +
会 —— 用途、参数、返回值和值得注意的副作用,让文档真正有用。
提交前要审查吗? +
务必。它起草准确的文档,但你应确认它符合预期行为。