通过 AI 理解标准化文档,自动执行标准化规范,确保代码、接口、文档的一致性和规范性
AI 读取 Markdown 标准文档,自动化执行各类开发规范
AI 根据接口规范文档,自动检查和生成符合标准的 API 接口
AI 按照文档模板标准,自动生成和检查技术文档的完整性
AI 理解编码规范文档,自动检查和修复代码风格问题
AI 根据数据库设计规范,检查表结构和 SQL 语句的规范性
AI 学习安全规范文档,自动检查代码中的安全隐患
AI 按照部署规范文档,检查和生成标准化的部署配置
从标准文档到自动化执行的完整流程
使用 Markdown 格式编写各类开发规范文档,定义标准和规则
AI 读取并理解标准文档内容,提取规则和检查点
AI 自动扫描代码、接口、文档,按照标准进行全面检查
生成详细的检查报告,AI 自动修复部分问题,提供修复建议
使用 Markdown 编写的标准化规范文档
# RESTful API 规范
## 1. 接口命名规范
- 使用小写字母和连字符
- 资源使用复数形式
- 示例: /api/v1/users
## 2. 统一响应格式
{
"code": 200,
"message": "success",
"data": {...}
}
AI 读取此文档后,会自动检查所有接口是否符合命名规范和响应格式标准
# Java 编码规范
## 1. 命名规范
- 类名: 大驼峰 UserService
- 方法名: 小驼峰 getUserById
- 常量: 全大写 MAX_SIZE
## 2. 注释规范
- 类必须有 JavaDoc 注释
- 公共方法必须注释
- 复杂逻辑必须注释
AI 会自动检查代码命名、注释完整性,并给出不符合规范的具体位置
# API 文档规范
## 必须包含的内容
1. 接口描述
2. 请求方法和路径
3. 请求参数说明
4. 响应参数说明
5. 请求示例
6. 响应示例
7. 错误码说明
AI 会检查每个接口文档是否包含所有必需内容,并自动补充缺失部分
# 数据库设计规范
## 1. 表命名规范
- 使用小写字母和下划线
- 表名使用复数: users
## 2. 字段规范
- 主键: id (bigint)
- 创建时间: created_at
- 更新时间: updated_at
- 软删除: deleted_at
AI 会检查数据库表结构是否符合命名和字段规范,并生成标准化的数据库文档