编程开源技术交流,分享技术与知识

网站首页 > 开源技术 正文

AI实用指南:Rules编写规则详解,从前端到后端的技术栈全覆盖

wxchong 2025-05-02 21:45:52 开源技术 2 ℃ 0 评论

在AI驱动的开发时代,掌握如何与AI助手高效协作已成为工程师的必备技能。本文全面梳理了不同技术领域的AI编程规则,帮助你划定合理边界,提升开发效率。


一、AI编程通用规则

1. 明确任务边界

在使用AI辅助编程时,首先要明确任务的边界与范围,这是避免AI生成冗余代码的关键。

  • 任务分解:将复杂任务拆分为明确的子任务,每个子任务有清晰输入和期望输出 Prompt 即代码:设计和管理AI 编程的最佳实践
  • 功能定义:详细说明功能需求、输入输出格式和预期行为
  • 约束与限制:明确说明性能要求、兼容性限制和安全考量

2. 编码规范与最佳实践

  • 遵循标准:要求AI生成的代码符合行业标准和最佳实践
  • 代码风格:指定代码风格(如缩进、命名约定、注释风格)
  • 测试用例:要求AI同时提供测试用例,确保代码质量

3. 避免常见陷阱

  • 避免幻觉:要求AI提供引用来源,或只基于可验证的事实提供建议
  • 跨界限制:明确指出AI生成代码后,人工审查和调整仍然必要
  • 迭代反馈:将AI视为协作伙伴,而非完全替代,通过反馈循环不断优化输出

二、前端工程师AI编程规则

1. Flutter开发规则

Flutter作为一款跨平台UI工具包,在与AI结合时需注意以下规则:

  • 布局规则:指导AI理解Flutter布局系统(Container、Row、Column、Stack等)的正确使用
  • 状态管理:明确使用哪种状态管理方案(Provider、Bloc、GetX等)
  • 组件复用:要求生成可复用的自定义Widget,避免代码重复
  • 平台兼容:明确需要兼容的平台,避免使用平台特有API

实例规则配置

你是Flutter专家,熟悉Dart语言和Flutter框架的所有最佳实践。
请遵循以下规则:
1. 使用Provider进行状态管理
2. 遵循面向对象设计原则,确保类的单一职责
3. 使用StatelessWidget优于StatefulWidget,除非确实需要状态管理
4. 所有UI组件必须支持自适应和响应式布局
5. 使用const构造函数优化性能
6. 代码格式应遵循Dart风格指南

正如Flutter 使用Cursor 和Figma 快速生成界面代码所述,使用AI生成Flutter代码时,可以直接从设计图输入开始,大幅提高开发效率。

2. React/Next.js开发规则

React和Next.js作为流行的前端框架,有其特定的AI编程最佳实践:

  • 组件设计:要求组件遵循单一职责原则,保持简洁
  • 状态管理:明确使用的状态管理库(Redux、Zustand、Context API等)
  • 服务端渲染:对于Next.js,明确哪些内容需服务端渲染,哪些客户端渲染
  • 路由策略:指定路由组织方式和命名规范

实例规则配置

你是React和Next.js专家,请遵循以下规则生成代码:
1. 使用函数组件和React Hooks,避免类组件
2. 使用Zustand进行状态管理
3. 组件文件结构采用原子设计模式
4. CSS使用Tailwind或styled-components
5. 数据获取优先使用React Query
6. 遵循ESLint推荐的代码风格

3. Vue开发规则

Vue开发中的AI编程规则:

  • 组件风格:明确Options API还是Composition API
  • 状态管理:指定Pinia或Vuex的使用方法
  • 命名规范:文件命名和组件命名规则

实例规则配置

你是Vue专家,请遵循以下规则:
1. 使用Vue 3和Composition API
2. 文件命名统一为小写中划线格式(如:user-list.vue)
3. 组件名使用PascalCase
4. 状态管理使用Pinia
5. 使用TypeScript增强类型安全
6. 样式使用scoped CSS或CSS模块

根据AI前端Vue规范,指定具体的属性顺序和分行规则也非常重要。

4. HTML+CSS+JS基础规则

对于基础前端开发,AI编程规则需包含:

  • 语义化HTML:要求使用正确的语义化标签
  • 响应式设计:指定断点和响应式策略
  • CSS组织:明确CSS组织方式(BEM、SMACSS等)
  • JavaScript规范:ES版本和功能使用范围

实例规则配置

你是前端研发专家,请遵循以下规则:
1. HTML必须语义化,适当使用ARIA属性增强可访问性
2. CSS采用BEM命名规范,使用变量管理颜色和尺寸
3. JavaScript使用ES6+语法,避免使用var
4. 响应式设计采用移动优先策略
5. 确保代码在主流浏览器上兼容

三、后端工程师AI编程规则

1. Node.js开发规则

Node.js作为JavaScript运行时,在后端开发中有其特定规则:

  • 异步处理:明确Promises、async/await的使用规范
  • 错误处理:规范化错误处理和日志记录
  • 模块组织:明确模块拆分和导入导出规则
  • 安全实践:指定安全措施和参数验证方法

实例规则配置

你是Node.js专家,请遵循以下规则:
1. 使用async/await处理异步,避免回调地狱
2. 遵循Express.js最佳实践或NestJS架构规范
3. 错误处理统一使用中间件处理
4. 使用dotenv管理环境变量
5. 使用Joi或Zod进行数据验证
6. 实现适当的日志策略

2. Python后端开发规则

Python作为强大的后端语言,AI编程规则应包含:

  • 框架选择:明确使用的框架(Flask、Django、FastAPI等)
  • 代码风格:指定PEP8或其他风格指南
  • API设计:REST或GraphQL的设计原则
  • 数据处理:数据库交互和模型设计规范

实例规则配置

你是Python后端专家,请遵循以下规则:
1. 使用FastAPI构建API服务
2. 代码风格严格遵循PEP8
3. 使用SQLAlchemy进行ORM操作
4. 实现RESTful API设计原则
5. 使用Pydantic进行数据验证
6. 测试代码覆盖率不低于80%

3. Java后端开发规则

Java在企业级应用中广泛使用,AI编程规则应包含:

  • 框架规范:Spring Boot、Spring Cloud等框架使用规范
  • 设计模式:常用设计模式的应用场景
  • 代码组织:包结构和命名规范
  • 性能考量:内存使用和并发处理优化

实例规则配置

你是Java后端专家,请遵循以下规则:
1. 使用Spring Boot开发RESTful服务
2. 遵循阿里巴巴Java开发手册规范
3. 使用分层架构(Controller、Service、Repository)
4. 异常处理统一使用全局异常处理器
5. 使用Lombok简化代码
6. 数据库访问使用MyBatis Plus

四、移动端工程师AI编程规则

1. iOS开发规则

iOS应用开发的AI编程规则:

  • 架构模式:明确MVC、MVVM、Clean等架构的使用
  • UI设计:遵循Apple人机界面指南
  • 内存管理:ARC使用规范
  • Swift规范:Swift语言最佳实践

实例规则配置

你是iOS开发专家,请遵循以下规则:
1. 使用Swift 5+,避免Objective-C(除非必要)
2. 遵循MVVM架构模式
3. 使用SwiftUI优于UIKit(除非有特定兼容需求)
4. 适配深色模式和Dynamic Type
5. 使用适当的内存管理技术,避免循环引用
6. 遵循Apple的人机界面指南

2. Android开发规则

Android应用开发的AI编程规则:

  • 架构组件:使用Android官方架构组件
  • 兼容策略:设备和系统版本兼容性处理
  • UI设计:Material Design规范的应用
  • Kotlin规范:Kotlin语言最佳实践

实例规则配置

你是Android开发专家,请遵循以下规则:
1. 使用Kotlin编写代码,避免Java
2. 遵循MVVM架构和Android架构组件
3. 使用Jetpack Compose优于XML布局
4. 实现Material Design 3设计规范
5. 使用协程处理异步操作
6. 兼容Android 6.0及以上版本

五、产品经理使用AI画原型图

产品经理可以利用AI工具快速创建原型,提高效率:

1. 使用AI绘制原型的规则

  • 需求明确化:提供清晰、详细的产品需求描述
  • 交互逻辑:明确说明页面之间的流转关系
  • 布局规范:指定布局偏好和设计风格
  • 数据呈现:明确数据展示格式和交互方式

实例规则配置

你是UI/UX专家,请根据以下规则生成原型:
1. 使用HTML和Tailwind CSS创建高保真原型
2. 遵循移动优先的响应式设计原则
3. 使用FontAwesome图标增强视觉效果
4. 确保界面简洁明了,减少认知负担
5. 保持元素间距一致,提高可读性
6. 使用直观的视觉层次引导用户注意力

2. AI原型工具应用案例

根据Claude3.7生成高保真原型UI 2.04的分享,产品经理可以使用Claude 3.7等先进模型,快速创建高保真原型。一个典型的工作流程是:

  1. 详细描述产品需求和用户流程
  2. 使用AI生成HTML+CSS的界面原型
  3. 通过迭代反馈优化设计细节
  4. 导出代码或设计稿供开发团队使用

正如产品经理有福了:利用AI直接生成原型图& UI设计图所述,AI生成的设计图可以直接导出为HTML、CSS代码,甚至支持Vue和React框架的代码,极大提高了产品设计的效率。


六、开源项目中的AI编程规则案例

1. GitHub上的优秀案例

许多开源项目已经开始实践AI辅助开发,并形成了一套规则:

  • Flutter Rules for Windsurf, Cursor, and Other AI-Powered IDEs6:专门为Flutter开发优化的AI规则集
  • unit-mesh/build-your-ai-coding-assistant7:构建AI辅助编码助手的完整指南

2. Cursor规则模板

Cursor作为流行的AI编程工具,其规则设置对开发效率影响巨大:

// .cursorrules 示例
{
  "role": "你是一位专业的[技术领域]工程师,精通[具体技术栈]。",
  "rules": [
    "始终遵循项目现有的代码风格和架构模式",
    "生成的代码必须包含适当的错误处理",
    "为所有函数添加清晰的文档注释",
    "实现单元测试以验证功能正确性",
    "考虑性能优化和安全最佳实践"
  ]
}

根据Cursor 高级技巧:Curosr Rules 释放AI 编程潜力的介绍,良好的Cursor规则可以:

  • 提高代码质量:确保AI生成的代码符合编码规范和最佳实践
  • 提升开发效率:减少手动编写重复代码的时间
  • 增强代码一致性:保持项目风格统一

七、AI编程中如何划定边界

在AI辅助开发中,划定合理边界至关重要:

1. 技术边界划分

根据万字分享5个产品经理工作中的AI编程场景的分析,AI编程的边界包括:

  • 代码生成质量:AI生成的代码可能存在语义偏差或功能缺陷
  • 上下文理解限制:AI可能无法全面理解项目的历史背景和全局架构
  • 创新思维局限:AI擅长模仿和优化,但在创新设计方面仍有局限

2. 人机协作的边界设定

  • AI负责:重复性代码生成、常规问题解决、代码格式化、文档生成
  • 人类负责:架构设计、业务逻辑判断、关键决策制定、安全审查
  • 协作区域:代码优化、问题诊断、测试用例设计

正如AI 辅助开发的最佳实践所建议,"手动介入"是不可避免的提升关键上下文的手段,包括:

  • 使用注释或特定标记语言在代码中添加上下文信息
  • 通过交互式界面实时提供反馈和修正
  • 编写详细的需求文档和设计说明

八、结合Prompt工程的最佳实践

1. 提示工程关键原则

有效的Prompt工程可以显著提升AI编程输出质量:

  • 明确任务:清晰定义期望AI完成的任务
  • 提供上下文:包含必要的背景信息和约束条件
  • 示例引导:通过少量示例说明期望的输出格式
  • 迭代优化:根据输出结果不断调整提示

根据Prompt Engineering:提示词工程最佳实践与应用的建议,良好的提示词应当包含:

  • 角色设定:明确AI应扮演的专家角色
  • 任务描述:详细说明任务目标和要求
  • 输出格式:指定期望的输出结构
  • 约束条件:列出必须遵循的规则和限制

2. 技术栈特定的提示模板

不同技术栈需要特定的提示模板,以下是一些示例:

前端开发提示模板

作为前端专家,请使用[框架名称]开发一个[组件描述]。
要求:
1. 使用[CSS方案]进行样式管理
2. 确保组件响应式设计,适配移动端和桌面端
3. 实现[具体功能]的交互逻辑
4. 考虑可访问性和性能优化

后端开发提示模板

作为后端专家,请设计并实现一个[功能描述]的API。
要求:
1. 使用[语言/框架]实现RESTful接口
2. 包含完整的输入验证和错误处理
3. 遵循[设计模式]组织代码结构
4. 考虑安全性和性能优化

九、总结与建议

  1. AI 编程核心原则:明确目标、提供上下文、迭代反馈和人机协作,确保 AI 辅助开发,而非完全替代人类。
  2. 持续学习建议:关注 AI 编程工具发展,掌握提示工程技巧,建立团队最佳实践库,定期评估代码质量与效率。
  3. 未来展望:AI 将具备更强上下文理解、技术栈优化、项目结构感知能力,并提供更完善的安全性能保障,助力开发者摆脱重复工作,专注创造性任务。
  4. 关键要点:遵循技术栈规则,有效利用 AI 编程助手,平衡 AI 与人类判断,在 AI 驱动的开发时代保持竞争力。

AI编程不是取代开发者,而是让开发者从繁琐的重复工作中解放,专注于更有创造性和挑战性的任务。掌握这些规则和最佳实践,将帮助你在AI驱动的开发时代保持竞争力。无论你是前端、后端、移动端开发者还是产品经理,AI都能成为你强大的助手,而不仅仅是一个工具。记住,AI编程的艺术在于知道何时使用AI,何时依靠人类的判断和创造力。找到这个平衡点,你将在新的开发范式中脱颖而出。

本文暂时没有评论,来添加一个吧(●'◡'●)

欢迎 发表评论:

最近发表
标签列表