# dev-standards

**Repository Path**: lanjf2000/dev-standards

## Basic Information

- **Project Name**: dev-standards
- **Description**: 致力于制定与推广前端与全栈开发规范，提升团队协作效率与代码质量，提供可落地的工程化标准指南。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-08-22
- **Last Updated**: 2026-09-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# dev-standards — 个人开发规范库

> **定位**：飞哥的个人开发规范总库（Java / 前端 / 数据库 / 性能优化），供个人项目与 AI 协作统一遵循
> **建立日期**：2026-05-09
> **同步**：本目录将同步至 gitee 作为通用规范仓库

---

## 目录结构

```
dev-standards/
├── README.md                  ← 本文件（总入口）
├── java-code-style/           ← ⭐ Java 个人代码风格规范（权威源）
│   ├── README.md              ←   分层架构 / Message 统一返回 / 全局异常 /
│   │                             事务自调用陷阱 / rollback-only 复盘 / AI 自检清单
│   └── references/            ←   《java工程代码规范》8 篇原始资料（溯源用）
├── 01-前端规范/                ← 前端设计规范
│   ├── 01-核心规范/           ←   设计原则/间距/布局/导航/交互/表单/数据展示/反馈
│   ├── 02-视觉风格/           ←   14 套视觉风格（配色/字体/阴影/背景/主题变量）
│   ├── 03-框架实现/           ←   框架级实现约定
│   └── 04-参考资源/           ←   外部参考
├── 02-后端规范/                ← 后端通用规范（Java/Python/SQL）
│   ├── 01-Java规范/           ←   项目结构/架构分层/编码/Spring Boot（04 指向 java-code-style）
│   ├── 02-Python规范/
│   ├── 03-数据库规范/          ←   SQL 编写规范
│   ├── 04-其他语言/           ←   预留（C++/QT 等）
│   └── 05-AI话术模板.md       ←   向 AI 提需求的标准话术
├── 03-性能优化/                ← 通用性能原则
└── 04-数据库设计规范/          ← 表结构/索引设计
```

## 使用方式

### 人读

按需进入对应目录；Java 后端编码风格以 `java-code-style/README.md` 为最高标准。

### 给 AI 读

```markdown
请读取 dev-standards 仓库的以下文件作为编码约束：
- java-code-style/README.md（Java 风格权威）
- 02-后端规范/01-Java规范/（00-03 通用规范）
我的任务：……
```

## 维护规则

1. **单一权威源**：每份规范只在一个位置维护；`02-后端规范/01-Java规范/04` 已改为指针文件，禁止恢复副本
2. **先改库、后同步项目**：规范变更先提交本仓库，引用方（如 web-module `doc/06-设计规范/`）按需同步
3. **实证优先**：`java-code-style/` 正文（个人实证）与 `references/`（通用原则）冲突时，以正文为准
4. **新增主题**：按"一个主题一个一级目录 + README 索引"扩展

## 规范书写铁律（新增/修改规范文档必须遵守）

1. **通用性**：规范内容必须通用，不绑定具体项目名、目录路径、接口地址、端口号；涉及具体项目用泛称（"示例项目"），示例用 `/api/xxx` 抽象路径，避免项目特有类名/包名/URL
2. **结构化**：每个文件聚焦一个主题；命名 `序号-类型-主题.md`；规则类以"规则"开头，踩坑记录以"踩坑"开头（踩坑可项目具体，但要提炼通用原则）
3. **可操作性**：每条规则配 ✅ 正确示例和 ❌ 错误示例；说明"为什么"而不只是"怎么做"；给出排查/验证方法
4. **避免过期**：不记录具体版本号（除非强相关）和瞬时配置（临时 IP、调试端口）；文档与代码不一致时以代码为准，更新文档

---

**维护人**：飞哥 + AI