Back to Details

ios-xcode

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

iOS Xcode & Tooling Best Practices

iOS Xcode与工具使用最佳实践

Comprehensive guide for Xcode project configuration, SwiftData persistence, testing, debugging, profiling, and app distribution. Contains 19 rules across 6 categories.
本指南全面介绍Xcode项目配置、SwiftData持久化、测试、调试、性能分析及应用分发的相关内容，涵盖6大类别共19条规则。

When to Apply

适用场景

Reference these guidelines when:
  • Setting up Xcode projects with AppStorage, ScenePhase, or widgets
  • Implementing SwiftData models, queries, and CRUD operations
  • Writing tests with Swift Testing framework
  • Debugging with breakpoints and console output
  • Profiling performance with Instruments
  • Distributing apps via TestFlight
  • Building for visionOS or integrating ML features
在以下场景中可参考本指南：
  • 配置包含AppStorage、ScenePhase或小组件的Xcode项目
  • 实现SwiftData模型、查询及CRUD操作
  • 使用Swift Testing框架编写测试用例
  • 借助断点与控制台输出进行调试
  • 使用Instruments进行性能分析
  • 通过TestFlight分发应用
  • 开发visionOS应用或集成ML功能

Rule Categories by Priority

按优先级划分的规则类别

PriorityCategoryImpactPrefix
1SwiftData & PersistenceCRITICAL
data-
2Project & PlatformHIGH
platform-
3TestingHIGH
test-
4Debugging & ProfilingMEDIUM-HIGH
debug-
, 
perf-
5DistributionMEDIUM
dist-
6Specialty PlatformsMEDIUM
ml-
, 
spatial-
优先级类别影响程度前缀
1SwiftData与持久化关键
data-
2项目与平台高
platform-
3测试高
test-
4调试与性能分析中高
debug-
, 
perf-
5应用分发中
dist-
6特色平台中
ml-
, 
spatial-

Quick Reference

快速参考

1. Project & Platform (HIGH)

1. 项目与平台（高优先级）

  • platform-app-storage
     - Use AppStorage for user preferences
  • platform-scene-phase
     - Respond to app lifecycle with ScenePhase
  • platform-widget-integration
     - Design for widget and Live Activity integration
  • platform-system-features
     - Integrate system features natively
  • platform-app-storage
     - 使用AppStorage存储用户偏好设置
  • platform-scene-phase
     - 通过ScenePhase响应应用生命周期
  • platform-widget-integration
     - 适配小组件与Live Activity集成设计
  • platform-system-features
     - 原生集成系统功能

2. SwiftData & Persistence (CRITICAL)

2. SwiftData与持久化（关键优先级）

  • data-model-macro
     - Define models with @Model macro
  • data-query-for-fetching
     - Use @Query for fetching data
  • data-model-container
     - Configure model containers
  • data-relationships
     - Define model relationships
  • data-crud-operations
     - Implement CRUD operations
  • data-model-macro
     - 使用@Model宏定义模型
  • data-query-for-fetching
     - 使用@Query获取数据
  • data-model-container
     - 配置模型容器
  • data-relationships
     - 定义模型关联关系
  • data-crud-operations
     - 实现CRUD操作

3. Testing (HIGH)

3. 测试（高优先级）

  • test-swift-testing
     - Use Swift Testing framework
  • test-preview-sample-data
     - Create preview sample data
  • test-preview-macro
     - Use #Preview macro for rapid iteration
  • test-swift-testing
     - 使用Swift Testing框架
  • test-preview-sample-data
     - 创建预览示例数据
  • test-preview-macro
     - 使用#Preview宏实现快速迭代

4. Debugging & Profiling (MEDIUM-HIGH)

4. 调试与性能分析（中高优先级）

  • debug-breakpoints
     - Use breakpoints for debugging
  • debug-console-output
     - Use console output for debugging
  • perf-instruments-profiling
     - Profile SwiftUI with Instruments
  • debug-breakpoints
     - 使用断点进行调试
  • debug-console-output
     - 使用控制台输出进行调试
  • perf-instruments-profiling
     - 使用Instruments分析SwiftUI性能

5. Distribution (MEDIUM)

5. 应用分发（中优先级）

  • dist-testflight
     - Distribute via TestFlight
  • dist-app-icons
     - Design app icons for distribution
  • dist-testflight
     - 通过TestFlight分发应用
  • dist-app-icons
     - 设计用于分发的应用图标

6. Specialty Platforms (MEDIUM)

6. 特色平台（中优先级）

  • ml-natural-language
     - Integrate Natural Language ML
  • spatial-visionos-windows
     - Build for visionOS spatial computing
  • ml-natural-language
     - 集成自然语言ML功能
  • spatial-visionos-windows
     - 开发visionOS空间计算应用

How to Use

使用方法

Read individual reference files for detailed explanations and code examples:
  • Section definitions - Category structure and impact levels
  • Rule template - Template for adding new rules
阅读各参考文件获取详细说明及代码示例：
  • 章节定义 - 类别结构与影响级别说明
  • 规则模板 - 添加新规则的模板

Reference Files

参考文件

FileDescription
references/_sections.mdCategory definitions and ordering
assets/templates/_template.mdTemplate for new rules
文件描述
references/_sections.md类别定义与排序说明
assets/templates/_template.md新规则模板