CLAUDE.md · 墨干社区/墨干理工套件

# 开发规范

## C++ 代码规范

1. **不使用标准 C++ 库**：Mogan 使用自研的 C++ 基础设施（如 lolly/moebius 库），内部类型（`string`、`list`、`array`、`tree`、`path` 等）均有自定义实现，与 `std::` 不兼容。
2. **输出流使用项目内置 `cout`**：调试输出应使用全局 `cout`（类型为 `tm_ostream`），而非 `std::cout`；换行使用 `LF` 宏或 `"\n"`，不要使用 `std::endl`。
3. **容器不支持现代 C++ 特性**：自定义容器（如 `rectangles`、`list`）不支持范围 for 循环（range-based for），需使用传统的迭代器或 `is_nil()`/`next` 遍历。
4. **类型转换使用项目函数**：自定义类型（如 `path`）没有标准 `operator<<` 重载，输出前需先用 `as_string()` 转换。

### 调试日志

1. **临时调试**：使用 `#ifdef LIII_DEBUG` / `#endif` 包裹全局 `cout`（`tm_ostream` 类型）。该宏仅在 debug 编译模式下定义，release 模式下整段代码会被编译器剔除，避免影响性能：
   ```cpp
   #ifdef LIII_DEBUG
   cout << "Assign " << p << ", " << u << " in " << st << "\n";
   #endif
   ```

2. **标准调试流**：使用项目预定义的调试输出流（如 `debug_std`、`debug_typeset`、`debug_boot`、`debug_edit` 等），配合 `DEBUG_STD`、`DEBUG_AUTO` 等宏开关，可通过外部配置启用/禁用：
   ```cpp
   if (DEBUG_STD) debug_boot << "Loading welcome message...\n";
   ```

3. **性能调试**：使用 `bench_start`、`bench_end` 等函数进行性能计时：
   ```cpp
   bench_start ("my_task");
   // ... 代码 ...
   bench_end ("my_task");
   ```

## 分支命名规则

分支格式：`username/200_27/xxx`

- `username`: 开发者用户名
- `200_27`: 项目标识符
- `xxx`: 功能描述或任务编号

例如：
- `da/200_27/xmake_debug`
- `da/200_27/fix_pdf_rendering`

## 提交规范

1. 一个 PR 至少分为两个 commit：
   - 第一个 commit 更新 `devel/xxxx.md` 任务文档
   - 后续 commit 为代码改动
2. 保持提交信息清晰、简洁，格式：`[编号] 简述`

## 代码推送规则

1. 如果 remote 是 GitHub，使用 `gh` 命令推送代码并创建 PR
2. 如果 remote 是 Gitee，直接使用 `git push` 推送代码
3. 推送前确保代码已通过本地测试
4. 保持提交信息清晰、简洁

## C++ 单元测试

1. 所有 `tests/**_test.cpp` 文件会自动被 xmake 识别为测试目标
2. 构建方式：`xmake b xxx_test`
3. 运行方式：`xmake r xxx_test`

## 构建命令

主项目构建：`xmake b stem`

## 工作流程

1. 基于主分支创建新分支
2. 按规范命名分支
3. 开发完成后直接 `git push` 推送
4. 不需要使用 GitHub CLI 工具

GVP 墨干社区/墨干理工套件

简介

发行版 (73)

贡献者

语言

近期动态

GVP墨干社区/墨干理工套件

简介

发行版 (73)

开源评估指数源自 OSS-Compass 评估体系，评估体系围绕以下三个维度对项目展开评估：

贡献者

语言

近期动态

搜索帮助

GVP 墨干社区/墨干理工套件