使用规范提高效率
约 611 字大约 2 分钟
2025-07-05
大模型的不足
现在的 AI 工具都是居于大模型,而大模型的边界非常宽泛。
为啥需要 rules
- 开发的项目都是技术栈混杂
比如有的用 vue 有的用 react。有的人用 java 有的人用 nodejs。 这样子没有统一的规范,很不友好。所以,这就是我使用 rules 进行规范的原因。
代码规范
代码规范.md
# nuxt 3
使用 nuxt 3
nuxt 配置文件为 nuxt.config.ts
# tailwindcss
如果配置文件有 tailwindcss,那么就使用 tailwindcss
否则使用默认的 css 就好
# Font Awesome
如果配置文件有 Font Awesome 图标库就使用
否则使用 emoji 图标就行
# package.json
这里面记录了使用的技术栈,生成代码的时候,需要参考相关框架
# api.http
这个文件是接口测试文件,对接接口的时候可以参考 api 文件
里面记录了请求参数,调用方法
# prisma/schema.prisma
这个文件记录了数据表的模型,生成接口或者前端渲染的时候
相关字段可以参考对应模型
# cdn
如果需要引入 cdn,那么引入无需注册的 cdn,免费公共的 cdn
比如图标库引入
# 目录规范
pages 目录:为页面目录名称
layouts 目录
components 目录:组件目录
server 目录:后台接口目录
server/api: 后台接口目录 api
# 接口文件规范
比如获取产品接口,需要 get 请求。
那么命名规则为: server/api/product.get.ts
# 接口返回规范
接口返回值需要按照如下规范
在渲染数据或者返回的时候,需要注意如下格式
{
code:200 //代表成功 。400代表失败,失败message设置错误原因
data: {} | [] //代表返回的对象或者数组
message: '' //备注
}
命令规范
命令规范.md
# 命令需要分步执行,不要用&&两条命令一起执行。
如果需要执行命令:cd my-nuxt-app && pnpm add -D @nuxtjs/tailwindcss
需要拆分成 2 步
第一步:cd my-nuxt-app
第二步:pnpm add -D @nuxtjs/tailwindcss
禁止用&& 符号,不兼容。用;替换
# 命令中的包管理一律使用 pnpm
不用 npm install 包
要使用 pnpm install 包
# 运行命令之前
运行命令之前,需要检查pageage.json或者配置文件nuxt.config.ts
有没有相关依赖,有就无需重复安装