使用 OpenAI 为函数生成 JSDoc 注释
内容提要
这篇文章介绍了Remotion内部包ai-improvements的用途，该包用于改进/生成Remotion源代码中函数的JSDoc注释和控制台日志。该包使用OpenAI API根据API文档和源代码生成函数的JSDoc注释。文章还提到了如何配置该包以及如何使用openai API生成JSDoc注释。文章最后提到了ts-morph库可以用于操作源代码的AST级别。
延伸解读
逆向生成文档的思路
通常做法是用源代码生成API文档，但Remotion的ai-improvements包反其道而行：利用已有的API文档和源代码，让OpenAI生成函数的JSDoc注释。这种逆向思路适合文档已存在但代码注释缺失的场景，能借助文档的准确性来补全代码注释，减少手动编写的工作量。
当前实现的输出限制
根据文章，generate-jsdoc.ts目前仅将生成的JSDoc输出到控制台，并未直接写入源文件。这意味着生成的注释需要人工复制到代码中，自动化程度有限。文章也提到，是否能用程序自动写入文件尚不确定，但建议查阅AST相关API，看能否在函数或类名前插入注释。
AST工具的可能用途
文章提到ts-morph库可用于在AST级别操作源代码，并指出shadcn-ui/ui项目已使用它。如果未来要实现自动写入JSDoc，ts-morph可能是一个候选工具，因为它能精确地在函数或类声明前插入注释节点。不过，文章并未给出具体实现方案，仅作为探索方向提出。
Q&A
ai-improvements包的主要功能是什么？
ai-improvements包用于改进和生成Remotion源代码中函数的JSDoc注释和控制台日志。
如何使用OpenAI API生成JSDoc注释？
该包使用OpenAI API根据API文档和源代码生成函数的JSDoc注释。
如何配置ai-improvements包？
文章讨论了如何配置ai-improvements包，包括导入必要的模块和设置生成JSDoc的任务。
ts-morph库在这个包中有什么用途？
ts-morph库可以用于操作源代码的AST级别，可能用于在文件中程序性地添加JSDoc注释。
ai-improvements包与传统的API文档生成有什么不同？
与传统方法不同，ai-improvements包使用OpenAI API直接从源代码生成JSDoc注释，而不是仅依赖于源代码。
生成的JSDoc注释如何输出？
生成的JSDoc注释会被写入控制台，但文章未明确说明是否可以程序性地写入文件。
