NavisworksTransport/.agents/skills/project-tools/README.md

49 lines
1.5 KiB
Markdown

# Project Tools Skill
## 概述
本 skill 用于指导 NavisworksTransport 项目中工具类的正确使用。
## 文件结构
```
project-tools/
├── SKILL.md # 主文档:工具类总览和快速参考
├── README.md # 本文件
├── utils/ # 各工具类详细文档
│ ├── DialogHelper.md # 对话框工具
│ ├── UnitsConverter.md # 单位转换工具
│ ├── LogManager.md # 日志工具
│ └── GeometryHelper.md # 几何计算工具
└── examples/ # 使用示例
└── common-usage.md # 常见场景示例
```
## 使用方法
1. **编写代码前**:查看 `SKILL.md` 确定需要的工具类
2. **具体使用时**:查看 `utils/` 下的详细文档
3. **参考示例**:查看 `examples/` 下的实际代码
## 核心原则
> **优先复用现有工具类,禁止重复造轮子**
### 必须使用的工具类(强制)
| 场景 | 工具类 | 错误示例 |
|------|--------|----------|
| 对话框Owner设置 | DialogHelper | `dialog.Owner = Application.Current.MainWindow` |
| 单位转换 | UnitsConverter | `value * 0.001` |
| 日志记录 | LogManager | `Console.WriteLine(...)` |
| 几何计算 | GeometryHelper | `Math.Sqrt(dx*dx + dy*dy)` |
## 检查清单
编写代码前,请确认:
- [ ] 阅读了 `SKILL.md` 中相关工具类的说明
- [ ] 查阅了 `utils/` 下的详细文档
- [ ] 代码中使用了正确的工具类方法
- [ ] 没有重复实现已有功能