Skip to content

Commit 609b72d

Browse files
author
liuyangyang
committed
about ai code creation
1 parent 7ea1dd5 commit 609b72d

File tree

1 file changed

+20
-7
lines changed

1 file changed

+20
-7
lines changed

CLAUDE.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
- 正式文档写到项目的 docs/ 目录下
1010
- 用于讨论和评审的计划、方案等文档,写到项目的 discuss/ 目录下
1111

12-
## Code Architecture
12+
## 代码框架
1313
- 代码必须简单清晰,易于理解
1414
- 编写代码的硬性指标,包括以下原则:
1515
(1)对于 Python 等动态语言,尽可能确保每个代码文件不要超过 300 行
@@ -43,20 +43,33 @@
4343

4444
## C++
4545
- 代码风格遵循 Google C++ Style Guide
46-
-
46+
- 代码尽可能简单,避免过度设计
47+
- 代码必须使用 .cpp 作为文件扩展名
48+
4749
## 依赖
50+
-- 需要添加依赖时,必须先征求用户的同意。
4851

49-
## 输出
50-
- 输出内容必须使用简体中文
52+
## 输出与日志
5153
- 输出PROJECT_STATUS.md 必须包含项目的主要功能、特性、优势、局限性等信息.包括每次更新的主要变化、优化点、新功能等。
54+
- 简单任务或者临时性的输出,可以不是用日志系统。
55+
- 工程简单或者本身就没有使用日志系统,可以不使用日志系统。直接使用原始数据输出。例如python用print(),C++使用cout。
56+
- 日志文件必须使用简体中文
57+
- 日志文件必须输出到 logs/ 目录下
58+
- 日志文件必须包含时间戳、模块名、日志等级、日志内容等信息
59+
- 日志文件必须按时间顺序排列
60+
- 日志文件必须定期清理,避免过大占用磁盘空间
61+
- 日志文件必须包含项目的主要功能、特性、优势、局限性等信息.包括每次更新的主要变化、优化点、新功能等。
5262

5363

64+
## 版本控制
65+
- 版本控制系统使用 Git
66+
- 版本控制系统必须包含 .gitignore 文件,用于排除不需要提交的文件
5467

55-
## 项目概述
56-
SimpleSensorSync 是一个为机器人和传感器融合系统设计的多传感器同步解决方案。它使用专用同步板为相机、激光雷达、IMU 和 GPS 等各种传感器提供精确的时间协调。
5768

58-
## 架构
5969

70+
71+
## 项目概述
72+
SimpleSensorSync 是一个为机器人和传感器融合系统设计的多传感器同步解决方案。它使用专用同步板为相机、激光雷达、IMU 和 GPS 等各种传感器提供精确的时间协调。
6073
### 核心组件
6174
- **infinite_sense_core/**: 提供同步功能的主库
6275
- `Synchronizer` 类: 网络、USB 和传感器管理的主协调器

0 commit comments

Comments
 (0)