news 2026/10/29 2:17:46

ws-http文档生成提示词

作者头像

张小明

前端开发工程师

1.2k 24
文章封面图
ws-http文档生成提示词
> **摘要**:本文档面向 `ws-http` 项目的 `doc/` 目录技术文档建设,提出一套以英文为默认主文档的开源文档方案。全文分为三步:第一步深度扫描 `src/` 源码,结合中文注释理解 `Core/`(HttpClient、Request、Response)、`Functional/`(Scenario、Assertion)、`Plugin/`、`NanoGpt/` 等核心模块的职责与业务逻辑,并输出《英文文档模块规划表》;第二步在确认规划后,为每个模块生成包含 Overview、Key Components、Usage Examples、Configuration、Dependencies 五部分的英文 Markdown 文档;第三步更新根目录 `README.md`,补充指向 `doc/` 各模块文档的导航链接。文档强调术语准确、示例真实可运行,并遵循 GitHub 相对路径规范。 你现在的任务是完善 `ws-http` 项目的 `doc/` 目录技术文档。鉴于项目源码注释主要为中文,请严格遵循“以英文为默认主文档”的开源标准,按以下步骤执行: ### 第一步:深度扫描与模块规划 1. **读取源码**:完整扫描 `src/` 目录,重点分析 `Core/` (HttpClient, Request, Response), `Functional/` (Scenario, Assertion), `Plugin/`, `NanoGpt/` 等核心模块。 2. **理解逻辑**:结合中文注释理解各类的职责、方法参数含义及业务逻辑,但**输出文档时必须使用专业、地道的技术英语**。 3. **输出规划**:列出一份《英文文档模块规划表》,包含建议的文件名(如 `core-client.md`)、模块职责简述、关键 API 列表。 - *注意*:暂不生成具体文件,仅输出规划清单供我确认。 ### 第二步:生成全量英文文档(待我确认后执行) 确认规划后,请在 `doc/` 目录下为每个模块创建对应的英文 Markdown 文件。每份文档必须包含: - **Overview**: 模块的核心设计意图与职责。 - **Key Components**: 核心类/接口的详细说明,参数与返回值类型需对齐 PHP 7.4+ 规范。 - **Usage Examples**: 提供基于真实代码的可运行 PHP 示例(严禁编造不存在的方法)。 - **Configuration**: 关键配置项说明。 - **Dependencies**: 模块间的依赖关系。 ### 第三步:根目录 README 更新 - 更新根目录 `README.md`(英文版),增加指向 `doc/` 下各模块文档的导航链接。 - 确保所有链接路径符合 GitHub 相对路径规范。 ### 约束条件 - **语言风格**:英文文档需符合国际开源社区习惯,术语准确(如将“场景”译为 "Scenario",“断言”译为 "Assertion")。 - **真实性**:所有代码示例必须从 `src/` 中的真实类和方法签名提取,确保可运行。 - **忽略中文输出**:此阶段仅生成英文文档,中文配套文档将在后续步骤单独生成。 请先执行第一步,输出《英文文档模块规划表》。
版权声明: 本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若内容造成侵权/违法违规/事实不符,请联系邮箱:809451989@qq.com进行投诉反馈,一经查实,立即删除!
网站建设 2026/10/29 2:17:34

第8-9周:C语言数组算法练习

在这一周,我学习了在数组中求最值,求和(基础和升级),打乱数组的数据,反转数组,查找(其中分基本查找,二分查找,分块查找,哈希查找)&…

作者头像 李华
网站建设 2026/10/29 2:17:07

绿色工厂申报反复卡壳?很多企业都栽在台账和数据协同上

做制造企业的朋友应该都有同感:申报绿色工厂,最难的从来不是写申报材料,而是把分散在车间、财务、设备、运维各个角落的数据收拢对齐。 不少工厂前期准备很久,自评表填得满满当当,现场专家一核查,问题立刻…

作者头像 李华
网站建设 2026/10/29 2:16:40

记录|程序员的月底复盘:清理代码Bug,也清理牙齿问题

又到了月底复盘的时候。平时复盘的都是项目进度和代码Bug,今天想了想,也该复盘一下自己的身体了。毕竟,身体才是革命的本钱。翻了翻自己的备忘录,发现有一项叫“洗牙”的任务一直挂在上面。平时加班多,周末总想躺着&am…

作者头像 李华
网站建设 2026/10/29 2:15:15

实验室用等离子表面处理设备处理消费电子小件的一点记录

最近帮朋友测了几组消费电子常用小件,用实验室那台等离子表面处理设备处理了一下,记录点数据。材料一:ABS耳机外壳。处理前达因值大概32 dyn/cm,喷涂PU漆后缩孔明显,百格2B—3B、边缘剥落。常压等离子处理后达因值到68…

作者头像 李华
网站建设 2026/10/29 2:14:19

大模型赋能搜推:小白程序员必看!收藏这份电商大模型学习指南

电商行业正经历深刻变革,大模型技术为搜推技术带来智能化和个性化的飞跃。文章分析了电商场景下大模型的应用问题,如商品知识理解、效果和个性化、时效性、成本和速度以及安全性等。同时,文章详细介绍了京东在大模型电商场景下的解决方案&…

作者头像 李华
网站建设 2026/10/29 2:11:53

编程没有被取代,被取代的是“写代码“这件事本身

从 Sam Altman 与 Matthew Berman 的 45 分钟访谈,看软件需求弹性、能力迁移与手艺的消失关于 AI 与程序员的关系,过去两年流行过两个截然相反的预言。第一个是"AI 会让开发者失业";第二个是"AI 只是工具,程序员照…

作者头像 李华