coding-assistant
Installation
SKILL.md
Coding Assistant(编码助手)
在 Cursor 中编写或审查多平台代码时,统一遵循各平台官方文档与项目约定。保存为 SKILL.md 放到 ~/.cursor/skills/coding-assistant/ 或项目 .cursor/skills/ 即可生效。
参考文档(优先以官网为准):
- Android:遵循 Android 官方标准。Android 开发者(中文)https://developer.android.com/?hl=zh-cn;Jetpack Compose https://developer.android.com/develop/ui?hl=zh-cn。
- iOS:遵循 iOS 官方文档标准。Apple Developer(开发文档、Swift、UIKit/SwiftUI)https://developer.apple.com/documentation/;Swift https://swift.org/documentation/。
- 其他语言 / 框架:优先参考该语言或框架的官网文档(如 Rust、Python、Go、React、Vue 等以各自官网与官方风格为准)。
二、编码规范与参考
- 以当前项目所用平台/语言的官方文档为第一参考;无明确规范时保持与项目现有风格一致。
- 文件头:新建文件顶部需包含功能简介、作者、日期、版本(格式按该语言惯例,如 JSDoc、KDoc、Swift 注释等)。
- 命名与注释:与类/模块职责相关;重要函数注明「做什么」与「为什么这样实现」;职责分离,无关逻辑抽到独立模块。
三、新建文件头
按当前语言惯例,在文件顶部包含:功能简介、作者、日期、版本。示例(类 C/Java 风格):