使用 OpenAI 为您的函数生成 JSDoc 注释。
本文的灵感来自于 Remotion 的内部包 ai-improvements。该内部包用于改进/生成 JSDoc 注释并登录控制台以获取 Remotion 源代码中的函数。
这个用例非常不同,因为您通常会使用源代码并让 OpenAI 生成 API 文档,但在 Remotion 中,这个内部包使用 OpenAI API 使用 API 文档和源代码为函数生成 JSDoc 注释。
我们将从高层次上看一下这个包是如何配置的:
- 改进-docs.ts
- 生成-jsdoc
改进文档
import path from "path"; import { OpenAI } from "openai"; import { getApis } from "./map-over-api"; import { findMistakes } from "./tasks/find-mistakes"; import { generateJSDocTask } from "./tasks/generate-jsdoc";
improve-docs.ts 具有上述导入。 generateJSDocTask 是从“tasks”文件夹导入的。
根据任务的不同,您可以生成 JSDoc 或查找错误。
生成JSDoc
generate-jsdoc.ts 使用 openai API,有如上图所示的提示。
请注意,这只会将生成的 JSDoc 写入控制台。是否可以以编程方式将这些 JSDoc 注释写入文件中?不确定,但值得阅读 AST 文档,看看是否有任何 API 可用于在函数或类名称上方添加 JSDoc 注释。 ts-morph 已知在 shadcn-ui/ui 中用于在 AST 级别操作源代码。
关于我们:
网站:https://thinkthroo.com/
Github:https://github.com/thinkthroo/thinkthroo(给我们一颗星!)
免费从头开始构建开源项目
提高团队编码技能。
需要项目帮助吗?请通过 thinkthroo@gmail.com 联系我们
参考:
https://github.com/remotion-dev/remotion/tree/main/packages/ai-improvements
https://github.com/remotion-dev/remotion/blob/main/packages/ai-improvements/improve-docs.ts
https://github.com/remotion-dev/remotion/blob/main/packages/ai-improvements/tasks/generate-jsdoc.ts
https://github.com/remotion-dev/remotion/blob/main/packages/ai-improvements/tasks/find-mistakes.ts
https://github.com/remotion-dev/remotion/blob/main/packages/ai-improvements/map-over-api.ts
https://github.com/remotion-dev/remotion/blob/main/packages/docs/src/data/articles.ts
以上是使用 OpenAI 为您的函数生成 JSDoc 注释。的详细内容。更多信息请关注PHP中文网其他相关文章!

热AI工具

Undresser.AI Undress
人工智能驱动的应用程序,用于创建逼真的裸体照片

AI Clothes Remover
用于从照片中去除衣服的在线人工智能工具。

Undress AI Tool
免费脱衣服图片

Clothoff.io
AI脱衣机

Video Face Swap
使用我们完全免费的人工智能换脸工具轻松在任何视频中换脸!

热门文章

热工具

记事本++7.3.1
好用且免费的代码编辑器

SublimeText3汉化版
中文版,非常好用

禅工作室 13.0.1
功能强大的PHP集成开发环境

Dreamweaver CS6
视觉化网页开发工具

SublimeText3 Mac版
神级代码编辑软件(SublimeText3)

Python更适合初学者,学习曲线平缓,语法简洁;JavaScript适合前端开发,学习曲线较陡,语法灵活。1.Python语法直观,适用于数据科学和后端开发。2.JavaScript灵活,广泛用于前端和服务器端编程。

JavaScript在Web开发中的主要用途包括客户端交互、表单验证和异步通信。1)通过DOM操作实现动态内容更新和用户交互;2)在用户提交数据前进行客户端验证,提高用户体验;3)通过AJAX技术实现与服务器的无刷新通信。

JavaScript在现实世界中的应用包括前端和后端开发。1)通过构建TODO列表应用展示前端应用,涉及DOM操作和事件处理。2)通过Node.js和Express构建RESTfulAPI展示后端应用。

理解JavaScript引擎内部工作原理对开发者重要,因为它能帮助编写更高效的代码并理解性能瓶颈和优化策略。1)引擎的工作流程包括解析、编译和执行三个阶段;2)执行过程中,引擎会进行动态优化,如内联缓存和隐藏类;3)最佳实践包括避免全局变量、优化循环、使用const和let,以及避免过度使用闭包。

Python和JavaScript在社区、库和资源方面的对比各有优劣。1)Python社区友好,适合初学者,但前端开发资源不如JavaScript丰富。2)Python在数据科学和机器学习库方面强大,JavaScript则在前端开发库和框架上更胜一筹。3)两者的学习资源都丰富,但Python适合从官方文档开始,JavaScript则以MDNWebDocs为佳。选择应基于项目需求和个人兴趣。

Python和JavaScript在开发环境上的选择都很重要。1)Python的开发环境包括PyCharm、JupyterNotebook和Anaconda,适合数据科学和快速原型开发。2)JavaScript的开发环境包括Node.js、VSCode和Webpack,适用于前端和后端开发。根据项目需求选择合适的工具可以提高开发效率和项目成功率。

C和C 在JavaScript引擎中扮演了至关重要的角色,主要用于实现解释器和JIT编译器。 1)C 用于解析JavaScript源码并生成抽象语法树。 2)C 负责生成和执行字节码。 3)C 实现JIT编译器,在运行时优化和编译热点代码,显着提高JavaScript的执行效率。

Python更适合数据科学和自动化,JavaScript更适合前端和全栈开发。1.Python在数据科学和机器学习中表现出色,使用NumPy、Pandas等库进行数据处理和建模。2.Python在自动化和脚本编写方面简洁高效。3.JavaScript在前端开发中不可或缺,用于构建动态网页和单页面应用。4.JavaScript通过Node.js在后端开发中发挥作用,支持全栈开发。
