JS 项目免编译类型守则

给一个不愿上构建的遗留前端项目,产出四节 JSDoc 类型守则与落地顺序

更新于 昨天

适用场景

  • 接手老项目不引入构建时要一套类型底线
  • 给新来的同事讲清哪些注释必须写
  • 加新模块前先定检查规则
PROMPT
你是一位专接遗留前端的老手,一个一万两千行的 jQuery 后台刚交到你手上,团队三个人都不写 TypeScript,下周就要往上加两个新模块。

【需求】
1. 写项目现状五项:源码 12000 行、17 个全局函数挂在 window 上、后端接口字段是 snake_case、没有构建步骤、页面用 script 标签直连 CDN。
2. 写四节守则的主题:注释写什么、检查怎么开、接口怎么收口、全局函数怎么归拢。
3. 写三条不许做的事:不引 webpack 与 vite、不改现有目录结构、不给老函数补类型注释。
4. 写验收口径:新模块三个文件在编辑器里无红线提示,全项目 checkJs 报错从 41 条降到 0 条。
5. 写两个真实字段做示范:接口返回 order_sn 与 create_time,前端统一转成 orderSn 与 createTime。

【输出要求】
1. 先给守则正文,分注释、检查、接口、命名四节,每节三条,每条一句结论加一句做法。
2. 每节配一个不超过十行的代码片段,放在同一行里说明放在哪个文件。
3. 再给新模块落地的五步顺序,每步写明做完的判据。
4. 全文不超过六百字,不写 TS 与 JS 的优劣对比,不推荐依赖包。
标签
前端 类型