全局gerenal.mdc配置

127 阅读2分钟

cursor学习

1.全局配置

  1. 请保持对话语言始终为中文
  2. 我的系统为win10
  3. 请使用JSDoc格式为代码添加中文注释
  4. 请使用正确的代码格式进行代码生成

image.png

2.全局gerenal.mdc配置

匹配规则:

  • *:匹配零个成多个字符。

  • ?:匹配—个字符。

  • **:匹配任意数量的子目录。

匹配所有的TypeScript文件: *.ts
匹配所有的JSON文件:*.json
匹配特定目录下的所有文件:src/config/**
匹配所有的markdown文件:**/*.md
匹配特定扩展名的文件:*.cpp,*.py

gerenal.mdc实例:

---
​
description:
​
globs:
​
alwaysApgly:true
​
---
​
项目通用规范
​
​
工程的目录结构
​
- doc目录是所有项目相关的文档
​
- dale-wechat小程序端
​
​
技术栈
​
- dale-wechat小程序端使用原生框架
​
​
项目结构规则
​
- 分层组织:按功能或领域划分目录,遵循“关注点分离”原则
​
- 命名一致:使用一致且描述性的目录和文件命名,反映其用途和内容
​
- 模块化:相关功能放在同一模块,减少跨模块依赖
​
- 适当嵌套:避免过深的目录嵌套,一般不超过3-4层
​
- 资源分类:区分代码、资源、配置和测试文件
​
- 依赖管理:集中管理依赖,避免多处声明
​
- 约定优先:遵循语言或框架的标准项目结构约定
​
​
通用开发原则
​
- 可测试性:编写可测试的代码,组件应保持单一职责
​
- DRY原则:避免重复代码,提取共用逻辑到单独的函数或类
​
- 代码简洁:保持代码简洁明了,遵循KISS原则(保持简单直接)
​
- 命名规范:使用描述性的变量、函数和类名,反映其用途和含义
​
- 注释文档:为复杂逻辑添加注释,编写清晰的文档说明功能和用法
​
- 风格一致:遵循项目或语言的官方风格指南和代码约定
​
- 利用生态:优先使用成熟的库和工具,避免不必要的自定义实现
​
- 架构设计:考虑代码的可维护性、可扩展性和性能需求
​
- 版本控制:编写有意义的提交信息,保持逻辑相关的更改在同一提交
​
- 异常处理:正确处理边缘情况和错误,提供有用的错误信息
​
​
响应语言
​
- 始终使用中文回复用户