了解一下 AI Doc Writer VS Code扩展

我从未见过喜欢编写文档的开发人员。至少他们理解它的价值，并且会不情愿地写它，但永远不会享受写它的过程。

有些人认为好的代码应该记录自己，但如果这是真的，那么为什么一个熟悉整个代码库的人对团队如此有价值呢？有很多知识，推理和上下文不能简单地从原始代码中推断出来。维护良好的良好文档只会为代码库增加价值和上下文。

这尤其适用于非类型编程语言。对我来说，唯一突出的语言是Python。虽然它被认为是非常"可读的"，但很多时候我发现自己试图通过在代码中查找使用它的其他位置来推断变量或参数的类型。

下面是一个语法对象的示例：

下面是与它附带的文档相同的对象：

如果没有文档，几乎不可能推断出属性的类型/结构。rules

适用于 Javascript、Typescript、Python 和 PHP 的 AI Doc Writer 是一个 VS Code 扩展，可为你使用 AI 生成文档。它的工作方式是选择要记录的代码，然后按"生成文档"按钮或点击键盘快捷键Cmd/Ctrl + .

下面演示了它的操作过程：

现在，让我们看一些例子。看看AI对你的代码的理解程度如何？

以下是演示的代码以及 AI 生成的文档：

AI对每个功能进行了简要总结，并对参数进行了简短描述。

让我们看看它如何与一些Javascript代码一起时的表现：

这个输出对我来说特别有趣，因为它能够得出结论，15可以被5和3整除，而不是说它在可以被15整除时打印"FizzBuzz"。然后，这让我开始思考，我还能如何测试它——它知道简单的几何方程吗？i

确实如此！它没有说"将PI与r乘以2的幂"它没有逐字解释代码的作用，而是能够智能地推断出这些变量正在计算几何方程。

总体而言，AI Doc Writer可以为开发人员节省大量时间，同时提高其代码库的质量和可读性。它使开发人员能够在一秒钟内智能地解释函数和代码片段并提供上下文。

也许是时候跳过编写文档的恐惧，让AI为你做这件事了。想自己试运行一下！可以前往https://marketplace.visualstudio.com/items?itemName=mintlify.document获取 。